Tidy up the class library #17
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # SPDX-FileCopyrightText: Public Domain | |
| # SPDX-License-Identifier: CC0-1.0 | |
| name: API Docs | |
| on: | |
| push: | |
| paths: | |
| - 'lib/**/*.cs' | |
| - 'docfx.json' | |
| - '.github/workflows/docfx.yml' | |
| branches-ignore: | |
| - 'dependabot/**' | |
| permissions: | |
| contents: read | |
| jobs: | |
| publish-docs: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| permissions: | |
| pages: write | |
| id-token: write | |
| runs-on: windows-latest | |
| steps: | |
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - uses: actions/setup-dotnet@3951f0dfe7a07e2313ec93c75700083e2005cbab # v4.3.0 | |
| with: | |
| dotnet-version: 8.0.x | |
| - name: Generate docs | |
| run: | | |
| dotnet tool restore | |
| dotnet restore | |
| dotnet docfx | |
| env: | |
| DOCFX_SOURCE_BRANCH_NAME: ${{ github.ref_name }} | |
| - name: Setup Pages | |
| uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1 | |
| with: | |
| path: './_site' | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5 |