Paper (#1404) #2490
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 Workflow | |
| on: | |
| push: | |
| branches: | |
| - 'main' | |
| pull_request: | |
| branches: | |
| - 'main' | |
| - '*/*' | |
| schedule: | |
| - cron: '0 0 * * 1' | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 35 | |
| steps: | |
| - uses: styfle/[email protected] | |
| name: Cancel Outdated Builds | |
| with: | |
| all_but_latest: true | |
| access_token: ${{ github.token }} | |
| - name: Checkout Repository | |
| uses: actions/checkout@v3 | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y protobuf-compiler | |
| - uses: Swatinem/rust-cache@v2 | |
| name: Enable Rust Caching | |
| - name: Build Docs | |
| run: | | |
| cargo doc --no-deps --workspace --profile=release-lto --document-private-items --bins --examples --features=full-ci --lib | |
| cargo test --doc --workspace --features=full-ci | |
| - name: Create documentation | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| run: | | |
| cp -R target/doc public | |
| echo '<meta http-equiv="refresh" content="0; url=hotshot">' > public/index.html | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./public | |
| cname: hotshot.docs.espressosys.com |