Give each package a readme that stands on its own #13
This file contains hidden or 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
| name: Docs (docfx -> Pages) | |
| # Builds the DocFX site (API reference generated from the XML docs + the markdown guides) and | |
| # publishes it to GitHub Pages at https://jrfrigat.github.io/YandexMusic/. | |
| # | |
| # One-time setup: Settings -> Pages -> Build and deployment -> Source: "GitHub Actions". | |
| on: | |
| push: | |
| branches: [ main ] | |
| paths: | |
| - 'docs/**' | |
| - 'src/**' | |
| - '.github/workflows/docs.yml' | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Never run two Pages deploys at once; let an in-progress run finish. | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| name: Build DocFX site | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v7 | |
| with: | |
| fetch-depth: 0 | |
| # docfx compiles the projects to read the public API; the libraries multi-target | |
| # net8.0/net9.0/net10.0, so install all three SDKs. | |
| - name: Setup .NET (8 / 9 / 10) | |
| uses: actions/setup-dotnet@v6 | |
| with: | |
| dotnet-version: | | |
| 8.0.x | |
| 9.0.x | |
| 10.0.x | |
| - name: Install DocFX | |
| run: dotnet tool update -g docfx | |
| - name: Build site | |
| run: docfx docs/docfx.json | |
| - name: Upload Pages artifact | |
| uses: actions/upload-pages-artifact@v5 | |
| with: | |
| path: docs/_site | |
| deploy: | |
| name: Deploy to GitHub Pages | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy | |
| id: deployment | |
| uses: actions/deploy-pages@v5 |