Generate Documentation #56
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: Generate Documentation | |
| on: | |
| push: | |
| tags: | |
| - "*" | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| generate-docs: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: macos-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v6 | |
| - uses: swift-actions/setup-swift@v3 | |
| with: | |
| swift-version: "6.2" | |
| - name: Generate documentation | |
| run: | | |
| # Dump symbol graph | |
| swift package dump-symbol-graph | |
| # Generate documentation using docc directly | |
| DOCC_JSON_PRETTYPRINT=YES xcrun docc convert \ | |
| Sources/Saga/Saga.docc \ | |
| --additional-symbol-graph-dir .build \ | |
| --output-path ./docs \ | |
| --hosting-base-path Saga | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: "./docs" | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |