forked from mirrors/kingfisher
62 lines
1.3 KiB
YAML
62 lines
1.3 KiB
YAML
name: Deploy Documentation
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
paths:
|
|
- 'docs-site/**'
|
|
- 'docs/**'
|
|
- 'crates/kingfisher-rules/data/rules/**'
|
|
- '.github/workflows/docs.yml'
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
|
|
concurrency:
|
|
group: "pages"
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- uses: astral-sh/setup-uv@v4
|
|
|
|
- uses: actions/setup-python@v5
|
|
with:
|
|
python-version: '3.12'
|
|
|
|
- name: Install dependencies
|
|
run: uv pip install --system -r docs-site/requirements.txt
|
|
|
|
- name: Prepare documentation
|
|
run: python3 docs-site/scripts/prepare-docs.py
|
|
|
|
- name: Generate rules page
|
|
run: python3 docs-site/scripts/generate-rules-page.py
|
|
|
|
- name: Build site
|
|
run: cd docs-site && mkdocs build --strict
|
|
env:
|
|
CI: true
|
|
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: docs-site/site
|
|
|
|
deploy:
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
runs-on: ubuntu-latest
|
|
needs: build
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v4
|