Skip to content

feat: update residue config to extended set #250

feat: update residue config to extended set

feat: update residue config to extended set #250

Workflow file for this run

name: Build and Deploy Documentation
on:
push:
branches:
- main
pull_request:
branches:
- main
# Allow only one concurrent deployment, queuing additional runs until the current one completes.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v5
- name: Install uv
uses: astral-sh/setup-uv@v6
with:
version: "latest"
- name: Install dependencies
# Only install dependencies for the docs group
run: uv sync --only-group docs
- name: Build documentation
# Avoid installing the project dependencies, which happens by default when executing `uv run` inside a project
run: uv run --no-project mkdocs build --clean
- name: Upload artifact
uses: actions/upload-pages-artifact@v4
with:
path: ./docs_public
# Deployment job
deploy:
# Only deploy on main branch
if: github.ref == 'refs/heads/main'
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4