chore: Release #39
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: Documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Install stable toolchain | |
| uses: dtolnay/rust-toolchain@stable | |
| - name: Cache target directory | |
| uses: actions/cache@v4 | |
| with: | |
| path: target | |
| key: ${{ runner.OS }}-${{ matrix.Rust }}-build-${{ hashFiles('Cargo.lock') }} | |
| restore-keys: | | |
| ${{ matrix.os }}-${{ matrix.Rust }}-build-${{ env.cache-name }}- | |
| ${{ matrix.os }}-${{ matrix.Rust }}-build- | |
| ${{ matrix.os }}-${{ matrix.Rust }}- | |
| - name: Build Documentation | |
| run: cargo doc --workspace --no-deps | |
| - name: Prepare to publish | |
| run: ./.github/scripts/prep_documentation.sh | |
| - name: Publish to Github Pages | |
| uses: JamesIves/github-pages-deploy-action@releases/v3 | |
| with: | |
| ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }} | |
| BASE_BRANCH: main # The branch the action should deploy from. | |
| BRANCH: gh-pages # The branch the action should deploy to. | |
| FOLDER: target/doc/ # The folder the action should deploy. | |
| CLEAN: true |