Skip to content

fix(extras): make NetBox custom-field reconcile re-runnable and compl… #322

fix(extras): make NetBox custom-field reconcile re-runnable and compl…

fix(extras): make NetBox custom-field reconcile re-runnable and compl… #322

Workflow file for this run

name: docs
on:
push:
branches:
- main
paths:
- "docs/**"
- "mkdocs.yml"
- "pyproject.toml"
- "uv.lock"
- ".github/workflows/docs.yml"
workflow_dispatch:
pull_request:
branches:
- main
paths:
- "docs/**"
- "mkdocs.yml"
- "pyproject.toml"
- "uv.lock"
- ".github/workflows/docs.yml"
permissions:
contents: write
concurrency:
group: docs-${{ github.ref }}
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v6
- name: Install uv
uses: astral-sh/setup-uv@v7
with:
enable-cache: true
python-version: "3.12"
- name: Sync docs dependencies
run: uv sync --frozen --extra docs --group dev
- name: Build docs
run: uv run mkdocs build --strict
deploy:
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
needs: build
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v6
- name: Install uv
uses: astral-sh/setup-uv@v7
with:
enable-cache: true
python-version: "3.12"
- name: Sync docs dependencies
run: uv sync --frozen --extra docs --group dev
- name: Build docs
run: uv run mkdocs build --strict
- name: Deploy to gh-pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: ./site