docs workflow #1
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: gh-pages | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| jobs: | |
| docs-build-test-deploy: | |
| name: Build, test and deploy docs | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write # To push a branch | |
| pull-requests: write # To create a PR from that branch | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: stable | |
| - run: (test -x $HOME/.cargo/bin/mdbook || cargo install --vers "^0.4" mdbook) | |
| - run: mdbook build docs && mdbook test docs | |
| - uses: JamesIves/[email protected] | |
| with: | |
| branch: gh-pages # The branch the action should deploy to. | |
| folder: docs/book # The folder the action should deploy. |