name: Documentation
on:
push:
branches: [ main ]
tags: [ 'v*' ]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build-docs:
name: Build Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v6
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
- name: Cache cargo registry
uses: actions/cache@v5
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-cargo-docs-${{ hashFiles('**/Cargo.lock') }}
- name: Build documentation
run: |
cargo doc --lib --no-deps --all-features --document-private-items
mkdir -p target/doc
echo '<meta http-equiv="refresh" content="0; url=tapsilat">' > target/doc/index.html
- name: Setup Pages
uses: actions/configure-pages@v6
- name: Upload documentation
uses: actions/upload-pages-artifact@v4
with:
path: target/doc
deploy-docs:
name: Deploy Documentation
needs: build-docs
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5