chore(deps): move serde-saphyr to 1.1 and refresh the lock #21
Workflow file for this run
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 site | |
| on: | |
| push: | |
| pull_request: | |
| env: | |
| CARGO_TERM_COLOR: always | |
| # This workflow is the single source of truth for the mdBook version | |
| # used to build the documentation site. Never install unpinned. | |
| MDBOOK_VERSION: 0.5.4 | |
| jobs: | |
| build: | |
| name: Build Documentation Site | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| toolchain: stable | |
| - name: Install mdBook | |
| run: cargo install mdbook --version ${{ env.MDBOOK_VERSION }} --locked | |
| - name: Build and link check | |
| # Builds site/ and fails on any mdbook warning or error line, on | |
| # any broken intra-book link, and on any page missing from | |
| # SUMMARY.md. The script is what contributors run locally, so CI | |
| # and the local check cannot drift apart. The site uses no mdBook | |
| # plugins, mdbook-linkcheck included; dependency minimalism | |
| # applies to docs tooling too. | |
| run: ./scripts/check-docs-site.sh | |
| deploy: | |
| name: Deploy Documentation Site | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/master' | |
| needs: build | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| toolchain: stable | |
| - name: Install mdBook | |
| run: cargo install mdbook --version ${{ env.MDBOOK_VERSION }} --locked | |
| - name: Build and link check | |
| run: ./scripts/check-docs-site.sh | |
| - name: Post-process for search and AI-assistant discovery | |
| # Adds sitemap.xml, robots.txt, canonical links, and JSON-LD to | |
| # the already-checked build output. See the script header for | |
| # why this cannot be done through mdBook's theme/head.hbs. | |
| run: ./scripts/postprocess-docs-site.sh | |
| - name: Upload site | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: site/book | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |