Skip to content

docs: align service guides with runtime behavior #12

docs: align service guides with runtime behavior

docs: align service guides with runtime behavior #12

Workflow file for this run

name: Deploy Docs to GitHub Pages
on:
push:
branches: [main]
paths:
- "docs/**"
- "mkdocs.yml"
- "docs/requirements.txt"
# Allow manual trigger
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Build job
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 dependencies
run: |
pip install --upgrade pip
pip install -r docs/requirements.txt
- name: Setup Pages
uses: actions/configure-pages@v6
- name: Build MkDocs site
run: mkdocs build
- name: Upload artifact
uses: actions/upload-pages-artifact@v5
with:
path: ./site
# Deployment job
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@v5