102 lines
2.3 KiB
YAML
102 lines
2.3 KiB
YAML
name: Deploy Documentation
|
|
|
|
on:
|
|
push:
|
|
branches: [ main ]
|
|
paths:
|
|
- 'docs/**'
|
|
- 'examples/**'
|
|
- 'consumer-guide/**'
|
|
- 'mkdocs.yml'
|
|
- 'requirements-mkdocs.in'
|
|
- 'requirements-mkdocs.txt'
|
|
- 'scripts/check_docs_links.py'
|
|
- '.github/workflows/infra-docs.yml'
|
|
pull_request:
|
|
branches: [ main ]
|
|
paths:
|
|
- 'docs/**'
|
|
- 'examples/**'
|
|
- 'consumer-guide/**'
|
|
- 'mkdocs.yml'
|
|
- 'requirements-mkdocs.in'
|
|
- 'requirements-mkdocs.txt'
|
|
- 'scripts/check_docs_links.py'
|
|
- '.github/workflows/infra-docs.yml'
|
|
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
|
|
concurrency:
|
|
group: "pages"
|
|
cancel-in-progress: false
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Setup Python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: '3.12'
|
|
|
|
- name: Install uv
|
|
uses: astral-sh/setup-uv@v3
|
|
|
|
- name: Install dependencies
|
|
run: uv pip install --system -r requirements-mkdocs.txt
|
|
|
|
- name: Setup Pages
|
|
uses: actions/configure-pages@v4
|
|
|
|
- name: Build documentation
|
|
run: mkdocs build
|
|
|
|
- name: Check docs links
|
|
run: python scripts/check_docs_links.py
|
|
|
|
- name: Setup Node
|
|
uses: actions/setup-node@v4
|
|
with:
|
|
node-version: '20'
|
|
|
|
- name: Enable pnpm
|
|
run: corepack enable
|
|
|
|
- name: Install config generator dependencies
|
|
working-directory: consumer-guide
|
|
run: pnpm install --frozen-lockfile
|
|
|
|
- name: Build config generator
|
|
working-directory: consumer-guide
|
|
run: NEXT_BASE_PATH=/config-generator pnpm build
|
|
|
|
- name: Copy config generator into docs site
|
|
run: |
|
|
mkdir -p site/config-generator
|
|
cp -R consumer-guide/out/. site/config-generator/
|
|
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: ./site
|
|
|
|
deploy:
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
runs-on: ubuntu-latest
|
|
needs: build
|
|
if: github.ref == 'refs/heads/main'
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v4
|