Documentation #370
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: | |
| - trunk | |
| pull_request: | |
| branches: | |
| - trunk | |
| schedule: | |
| - cron: "0 0 * * TUE" | |
| concurrency: | |
| group: docs-${{ github.head_ref }} | |
| env: | |
| CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse | |
| jobs: | |
| rustdoc: | |
| name: Build Rust API docs | |
| runs-on: ubuntu-latest | |
| env: | |
| RUSTDOCFLAGS: -D warnings -D rustdoc::broken_intra_doc_links --cfg docsrs | |
| RUST_BACKTRACE: 1 | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/[email protected] | |
| - name: Install Rust toolchain | |
| uses: artichoke/setup-rust/[email protected] | |
| - name: Check docs with no default features | |
| run: cargo doc --workspace --no-default-features | |
| - name: Clean docs | |
| run: cargo clean | |
| - name: Build Documentation | |
| run: cargo doc --workspace | |
| - name: Deploy Docs | |
| uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v3.9.2 | |
| if: github.ref == 'refs/heads/trunk' | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./target/doc | |
| publish_branch: gh-pages | |
| user_name: artichoke-ci | |
| user_email: [email protected] | |
| # only have the most recent docs in the `gh-pages` branch | |
| # https://github.com/artichoke/artichoke/issues/1826 | |
| force_orphan: true |