Skip to content

chore(v3)!: remove unnecessary underscores #637

chore(v3)!: remove unnecessary underscores

chore(v3)!: remove unnecessary underscores #637

Workflow file for this run

---
name: docs
on:
push:
branches:
- main
pull_request:
branches:
- main
env:
STABLE_PYTHON_VERSION: '3.13'
FORCE_COLOR: '1'
HATCH_VERBOSE: '1'
jobs:
build:
name: Build docs
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0
- name: Set up uv
uses: astral-sh/setup-uv@d8db0a86d3d88f3017a4e6b8a1e2b234e7a0a1b5 # v4.0.0
with:
enable-cache: true
cache-dependency-glob: |
**/pyproject.toml
**/uv.lock
- name: Install Python
run: uv python install ${{ env.STABLE_PYTHON_VERSION }}
- name: Install Hatch
run: uv tool install hatch
- name: Build docs
run: |
hatch run mkdocs build
- name: Upload artifact
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
with:
path: site
publish:
name: Publish docs
if: github.ref == 'refs/heads/main'
needs: build
runs-on: ubuntu-latest
permissions:
contents: read
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@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4