ci: change to use uv action #349
Workflow file for this run
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: Docs | |
on: | |
push: | |
branches: | |
- master | |
pull_request: | |
jobs: | |
build: | |
name: Build docs (python-${{ matrix.python-version }}, ${{ matrix.os }}) | |
strategy: | |
matrix: | |
python-version: | |
# - "3.10" | |
# - "3.11" | |
# - "3.12" | |
- "3.13" | |
os: | |
- ubuntu-latest | |
# - macos-latest | |
# - windows-latest | |
fail-fast: false | |
runs-on: ${{ matrix.os }} | |
steps: | |
- name: Setup pandoc | |
run: | | |
wget https://github.com/jgm/pandoc/releases/download/2.18/pandoc-2.18-1-amd64.deb && sudo dpkg -i pandoc-2.18-1-amd64.deb | |
sudo apt-get install pandoc-citeproc | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Install uv | |
uses: astral-sh/setup-uv@v2 | |
with: | |
enable-cache: true | |
cache-dependency-glob: "uv.lock" | |
- name: Set up Python ${{ matrix.python-version }} | |
run: uv python install ${{ matrix.python-version }} | |
- name: Install the project | |
run: uv sync --all-extras --dev | |
- name: Build docs | |
run: uv run mkdocs build | |
- name: Minimize uv cache | |
run: uv cache prune --ci | |
deploy: | |
name: Deploy docs | |
needs: build | |
if: github.event_name == 'push' && github.ref == 'refs/heads/master' | |
runs-on: ubuntu-latest | |
steps: | |
- name: Setup pandoc | |
run: | | |
wget https://github.com/jgm/pandoc/releases/download/2.18/pandoc-2.18-1-amd64.deb && sudo dpkg -i pandoc-2.18-1-amd64.deb | |
sudo apt-get install pandoc-citeproc | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Install uv | |
uses: astral-sh/setup-uv@v2 | |
with: | |
enable-cache: true | |
cache-dependency-glob: "uv.lock" | |
- name: "Set up Python" | |
uses: actions/setup-python@v5 | |
with: | |
python-version-file: "pyproject.toml" | |
- name: Install the project | |
run: uv sync --all-extras --dev | |
- name: Deploy docs | |
run: uv run mkdocs gh-deploy --force | |
- name: Minimize uv cache | |
run: uv cache prune --ci |