Skip to content
Deploy Documentation

docs: complete early adopter documentation package #59

Sign in to view logs

docs: complete early adopter documentation package

docs: complete early adopter documentation package #59

Workflow file for this run

.github/workflows/docs.yml at ba4474e
name: Deploy Documentation
on:
push:
branches: [main]
paths:
- "docs/**"
- "mkdocs.yml"
- ".github/workflows/docs.yml"
pull_request:
branches: [main]
paths:
- "docs/**"
- "mkdocs.yml"
workflow_dispatch:
permissions:
contents: write # Required to push to gh-pages
pages: write
id-token: write
jobs:
# ─────────────────────────────────────────────────────────────────
# Build documentation (runs on every PR to validate)
# ─────────────────────────────────────────────────────────────────
build:
name: Build Docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0 # Full history for git-revision-date-localized
- uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
with:
python-version: "3.11"
cache: pip
- name: Install MkDocs + plugins
run: |
pip install \
mkdocs-material==9.5.* \
mkdocs-minify-plugin==0.8.* \
mkdocs-git-revision-date-localized-plugin==1.2.* \
mike==2.1.*
- name: Build documentation
run: mkdocs build --strict --site-dir site/
- name: Upload built site (artifact)
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
with:
name: docs-site
path: site/
retention-days: 7
# ─────────────────────────────────────────────────────────────────
# Deploy to GitHub Pages (only on push to main)
# ─────────────────────────────────────────────────────────────────
deploy:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
needs: [build]
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0
- uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
with:
python-version: "3.11"
cache: pip
- name: Install MkDocs + plugins
run: |
pip install \
mkdocs-material==9.5.* \
mkdocs-minify-plugin==0.8.* \
mkdocs-git-revision-date-localized-plugin==1.2.* \
mike==2.1.*
- name: Configure Git identity
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
- name: Deploy to GitHub Pages (gh-pages branch)
run: mkdocs gh-deploy --force --clean --verbose