Skip to content

fix/mike 2 (#419)

fix/mike 2 (#419) #29

Workflow file for this run

name: Build and Deploy Documentation
on:
push:
branches:
- main
# paths:
# - "docs/**"
# - "mkdocs.yml"
release:
types: [published]
permissions:
contents: write
pages: write
id-token: write
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
enable-cache: true
- name: Set up Python
run: uv python install
- name: Install the project
run: uv sync --all-extras --dev
- name: Configure Git
run: |
git config user.name 'github-actions[bot]'
git config user.email 'github-actions[bot]@users.noreply.github.com'
- name: Build Docs Website
run: |
if [ "${{ github.event_name }}" = "release" ]; then
uv run mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest
uv run mike set-default --push ${{ github.event.release.tag_name }}
else
uv run mike deploy --push main
uv run mike set-default --push main
fi
deploy:
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
ref: gh-pages
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: '.'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4