athena-python-client/.github/workflows/docs.yml at main · crispthinking/athena-python-client · 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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
name: Build and Deploy Documentation

on:
  push:
    branches: [main, master]
    paths:
      - "docs/**"
      - "src/**"
      - "examples/**"
      - "README.md"
      - "pyproject.toml"
      - ".github/workflows/docs.yml"
  pull_request:
    branches: [main, master]
    paths:
      - "docs/**"
      - "src/**"
      - "examples/**"
      - "README.md"
      - "pyproject.toml"
      - ".github/workflows/docs.yml"
  release:
    types: [published]
  workflow_dispatch:
    inputs:
      reason:
        description: "Reason for manual documentation build"
        required: false
        default: "Manual trigger"

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          fetch-depth: 0

      - name: Install uv
        uses: astral-sh/setup-uv@v7
        with:
          enable-cache: true

      - name: Set version from tag
        run: |
          if [[ "$GITHUB_REF" == refs/tags/* ]]; then
            TAG_VERSION=${GITHUB_REF#refs/tags/}
            # Remove 'v' prefix if present
            VERSION=${TAG_VERSION#v}
            echo "Setting version to: $VERSION"
            uv version "$VERSION"
          else
            echo "Not building from a tag, using default version"
          fi

      - name: Install dependencies
        run: uv sync --locked --group docs

      - name: Build documentation
        run: |
          cd docs
          uv run make clean html

      - name: Setup Pages
        uses: actions/configure-pages@v6
        if: github.event_name == 'release' && github.event.action == 'published'

      - name: Upload artifact for GitHub Pages
        uses: actions/upload-pages-artifact@v4
        if: github.event_name == 'release' && github.event.action == 'published'
        with:
          path: docs/_build/html

      - name: Upload documentation artifacts
        uses: actions/upload-artifact@v7
        if: github.event_name != 'release'
        with:
          name: documentation
          path: docs/_build/html

      - name: Upload build artifacts for debugging
        uses: actions/upload-artifact@v7
        if: failure()
        with:
          name: docs-build-artifacts
          path: |
            docs/_build/
            docs/*.log

  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    if: github.event_name == 'release' && github.event.action == 'published'
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5