feat(mdbook): improve mdbook generics behaviour and fix broken links #110
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: Deploy mdBook to GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - staging | |
| paths: | |
| - 'docs/**' | |
| - 'crates/xtask/**' | |
| - '.github/workflows/mdbook.yml' | |
| pull_request: | |
| branches: | |
| - "**" | |
| paths: | |
| - 'docs/**' | |
| - 'crates/xtask/**' | |
| - '.github/workflows/mdbook.yml' | |
| jobs: | |
| build: | |
| name: Build Book - mdbook | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: stable | |
| override: true | |
| - name: Rust Cache | |
| uses: Swatinem/[email protected] | |
| - name: Install mdBook | |
| run: cargo xtask init --dont-update-ide | |
| - name: Build the book | |
| run: cargo xtask docs --no-rust-docs | |
| - name: Deploy to GitHub Pages | |
| if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/staging' | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/book |