openai-agents-python/.github/workflows/docs.yml at main · NodeOps-app/openai-agents-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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
name: Deploy docs

on:
  push:
    branches:
      - main
    paths:
      - "docs/**"
      - "mkdocs.yml"
      - "uv.lock"
      - ".github/workflows/docs.yml"

permissions: {}

concurrency:
  group: docs-deploy
  cancel-in-progress: false
  queue: max

jobs:
  build_docs:
    runs-on: ubuntu-latest
    permissions:
      contents: read
    outputs:
      deploy: ${{ steps.docs-deploy.outputs.run }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
        with:
          persist-credentials: false
      - name: Determine docs deployment changes
        id: docs-deploy
        env:
          BASE_SHA: ${{ github.event.before }}
          HEAD_SHA: ${{ github.sha }}
        run: ./.github/scripts/detect-changes.sh docs-deploy
      - name: Setup uv
        if: steps.docs-deploy.outputs.run == 'true'
        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # setup-uv v9.0.0; uv 0.11.14
        with:
          version: "0.11.14"
          enable-cache: true
          prune-cache: true
          python-version: "3.14"
      - name: Install dependencies
        if: steps.docs-deploy.outputs.run == 'true'
        env:
          UV_FROZEN: "1"
        run: make sync
      - name: Build docs
        if: steps.docs-deploy.outputs.run == 'true'
        env:
          UV_FROZEN: "1"
        run: make build-docs
      - name: Upload site
        if: steps.docs-deploy.outputs.run == 'true'
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: docs-site
          path: site/
          include-hidden-files: true
          if-no-files-found: error
          retention-days: 1

  deploy_docs:
    needs: build_docs
    if: needs.build_docs.outputs.deploy == 'true'
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: Checkout published branch
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
        with:
          ref: gh-pages
          path: published
      - name: Download site
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: docs-site
          path: site
      - name: Publish static files
        shell: bash
        run: |
          # Copy only static files; keep checkout metadata outside the artifact.
          rsync --recursive --delete --exclude=.git site/ published/
          touch published/.nojekyll
          git -C published config user.name 'github-actions[bot]'
          git -C published config user.email '41898282+github-actions[bot]@users.noreply.github.com'
          git -C published add --all
          if ! git -C published diff --cached --quiet; then
            git -C published commit -m "Deploy docs for $GITHUB_SHA"
            git -C published push origin HEAD:gh-pages
          fi