name: Deploy
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
concurrency:
group: deploy
cancel-in-progress: false
env:
CARGO_TERM_COLOR: always
jobs:
docs:
name: Build and upload rust documentation
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install Rust
uses: actions-rust-lang/setup-rust-toolchain@v1
- name: Cache Dependencies
uses: actions/cache@v4
with:
path: |
~/.cargo/registry
~/.cargo/git
.bin
target
key: ${{ runner.os }}-rust-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-rust-${{ hashFiles('**/Cargo.lock') }}
- name: Generate docs
run: |
cargo just doc-gen
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: rust-docs
path: target/doc
if-no-files-found: error
compose:
name: Compose artifacts for deployment
runs-on: ubuntu-latest
needs: docs
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup pages
id: pages
uses: actions/configure-pages@v5
- name: Download generated rustdocs
uses: actions/download-artifact@v4
with:
name: rust-docs
path: output/docs
- name: Upload docs artifact
uses: actions/upload-pages-artifact@v3
with:
path: output/
deploy:
if: github.event_name == 'push'
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
needs: compose
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4