doc: generate cargo docs on github pages #2
Workflow file for this run
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
| name: CI | ||
| # Controls when the workflow will run | ||
| on: | ||
| # Triggers the workflow on push or pull request events but only for the "main" branch | ||
| push: | ||
| branches: [ "main" ] | ||
| pull_request: | ||
| branches: [ "main" ] | ||
| name: Generate cargo docs | ||
| jobs: | ||
| docs: | ||
| name: Docs | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| - name: Setup Rust | ||
| uses: dtolnay/rust-toolchain@stable | ||
| - name: Configure cache | ||
| uses: Swatinem/rust-cache@v2 | ||
| - name: Setup pages | ||
| id: pages | ||
| uses: actions/configure-pages@v4 | ||
| - name: Clean docs folder | ||
| run: cargo clean --doc | ||
| - name: Build docs | ||
| run: cargo doc --no-deps | ||
| - name: Add redirect | ||
| run: echo '<meta http-equiv="refresh" content="0;url=aoc/index.html">' > target/doc/index.html | ||
| - name: Remove lock file | ||
| run: rm target/doc/.lock | ||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: target/doc | ||
| deploy: | ||
| name: Deploy | ||
| runs-on: ubuntu-latest | ||
| needs: docs | ||
| # Grant GITHUB_TOKEN the permissions required to make a Pages deployment | ||
| permissions: | ||
| pages: write # to deploy to Pages | ||
| id-token: write # to verify the deployment originates from an appropriate source | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 | ||
