deploy_documentation.yml

name: Deploy Documentation

# Controls when the action will run. Triggers the workflow on push
on:
  workflow_dispatch:
  push:
    branches: [main]

    paths:
    - 'src/docs/*'
    - 'src/schema/*.yaml'

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  build-docs:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
    #----------------------------------------------
    #       check-out repo and set-up python
    #----------------------------------------------
    - name: Check out repository
      uses: actions/checkout@v4
      with:
        # persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token
        fetch-depth: 0 # otherwise, you will failed to push refs to dest repo

    #----------------------------------------------
    #                 install uv
    #----------------------------------------------
    - name: Install uv
      uses: astral-sh/setup-uv@v6
      with:
        python-version: "3.11"
        enable-cache: true
        cache-dependency-glob: "uv.lock"

    #----------------------------------------------
    #          install project dependencies
    #----------------------------------------------
    - name: Install dependencies
      run: uv sync --dev --locked --no-progress

    #----------------------------------------------
    #  Create documentation and deploy.
    #----------------------------------------------
    - name: Create local docs
      run: |
        mkdir docs
        touch docs/.nojekyll
        cp -r src/docs/* docs/
        make gendoc
        make mkd-gh-deploy