Skip to content

feat(api)!: complete entity dynamic mapping dry-run workflow #498

feat(api)!: complete entity dynamic mapping dry-run workflow

feat(api)!: complete entity dynamic mapping dry-run workflow #498

Workflow file for this run

---
name: Deploy Documentation to GitHub Pages
on: # yamllint disable-line rule:truthy
push:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/deploy_docs.yml'
pull_request:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/deploy_docs.yml'
release:
types: [created]
workflow_dispatch:
concurrency:
group: "pages-${{ github.ref }}"
cancel-in-progress: false
jobs:
build:
name: Build Documentation
runs-on: ubuntu-latest
permissions:
contents: read
pages: write
id-token: write
steps:
- name: Checkout repository
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: '3.14'
- name: Install uv
uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2
with:
enable-cache: false
- name: Install dependencies
working-directory: docs
run: |
uv sync --no-build --frozen
- name: Build documentation
working-directory: docs
run: |
uv run --no-build --frozen zensical build
- name: Check navigation links
run: |
bash .github/scripts/check_navigation.sh
- name: Setup Pages
if: github.event_name == 'release'
uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0
- name: Upload artifact
if: github.event_name == 'release'
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
with:
path: 'docs/site'
deploy:
name: Deploy to GitHub Pages
if: github.event_name == 'release'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
permissions:
contents: read
pages: write
id-token: write
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0