nighthawk-python/.github/workflows/docs.yml at main · kurusugawa-computer/nighthawk-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
name: Build and deploy docs to GitHub Pages

on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "src/nighthawk/**"
      - "mkdocs.yml"
      - "pyproject.toml"
      - "uv.lock"
      - ".python-version"
      - ".github/workflows/docs.yml"
  pull_request:
    branches: [main]
    paths:
      - "docs/**"
      - "src/nighthawk/**"
      - "mkdocs.yml"
      - "pyproject.toml"
      - "uv.lock"
      - ".python-version"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: pages-${{ github.event_name == 'pull_request' && github.ref || 'deployment' }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false

      # setup-uv publishes no floating major tag since v8, so pin an exact release.
      - uses: astral-sh/setup-uv@v10.3.0
        with:
          python-version: "3.13"
          # The docs group is a subset of the cache "test (3.13)" saves under
          # this key, so restore it here but never overwrite it.
          save-cache: false

      - name: Install dependencies
        # The default dev group supplies Ruff for API signature formatting.
        run: uv sync --locked --group docs

      - name: Build docs
        run: uv run --no-sync mkdocs build

      - uses: actions/upload-pages-artifact@v5
        if: github.event_name != 'pull_request'
        with:
          path: site

  deploy:
    if: github.event_name != 'pull_request'
    needs: build
    runs-on: ubuntu-latest
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v5