docs.yml

# copy from: https://github.com/frankie567/httpx-ws/blob/main/.github/workflows/docs.yml

# WARNING: Do not change the name of this file, keep `docs.yml`.
# markdown badges are hard-coded to point to this file.

name: Deploy documentation

# Since document updates may be frequent,
# we do not run tests when deploying documents,
# instead test during the PR stage.
on:
  push:
    branches:
      - main
  workflow_dispatch:

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

# Default to bash
defaults:
  run:
    shell: bash

jobs:
  build-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        # https://github.com/timvink/mkdocs-git-revision-date-localized-plugin#note-when-using-build-environments
        with:
          fetch-depth: 0
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install hatch
      - name: Build
        run: hatch run docs:docs-build
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v2
        with:
          path: ./site

  deploy-docs:
    needs: build-docs
    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write # to deploy to Pages
      id-token: write # to verify the deployment originates from an appropriate source
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v3