InvokeAI/.github/workflows/deploy-docs.yml at main · invoke-ai/InvokeAI · 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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
name: 'docs'

on:
  push:
    branches:
      - 'main'
  pull_request:
    types:
      - 'ready_for_review'
      - 'opened'
      - 'synchronize'
  workflow_dispatch:
    inputs:
      deploy_target:
        description: 'Deploy target (custom = invoke.ai, ghpages = invoke-ai.github.io/InvokeAI)'
        type: choice
        options:
          - custom
          - ghpages
        default: custom

permissions:
  contents: read
  pull-requests: read

concurrency:
  group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
  cancel-in-progress: true

jobs:
  changes:
    runs-on: ubuntu-latest
    outputs:
      docs: ${{ steps.manual.outputs.docs || steps.filter.outputs.docs }}
    steps:
      - name: checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: mark manual run
        if: github.event_name == 'workflow_dispatch'
        id: manual
        run: echo "docs=true" >> "$GITHUB_OUTPUT"

      - name: detect docs-related changes
        if: github.event_name != 'workflow_dispatch'
        id: filter
        uses: dorny/paths-filter@v3
        with:
          filters: |
            docs:
              - '.github/workflows/deploy-docs.yml'
              - 'docs/**'
              - 'scripts/generate_docs_json.py'
              - 'invokeai/app/**'
              - 'invokeai/backend/**'
              - 'pyproject.toml'
              - 'uv.lock'

  check-and-build:
    needs: changes
    if: |
      github.event_name == 'workflow_dispatch' ||
      (github.event_name == 'pull_request' &&
        github.event.pull_request.draft == false &&
        needs.changes.outputs.docs == 'true') ||
      (github.event_name == 'push' && needs.changes.outputs.docs == 'true')
    runs-on: ubuntu-22.04
    timeout-minutes: 20
    steps:
      - name: checkout
        uses: actions/checkout@v4

      # Python (needed for generate-docs-data)
      - name: setup uv
        uses: astral-sh/setup-uv@v5
        with:
          version: '0.6.10'
          enable-cache: true
          python-version: '3.11'

      - name: setup python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'

      # generate_docs_json.py only needs the invokeai package importable
      # (pydantic + invokeai.app/backend). Skip the [test] extra to keep CI fast.
      - name: install python dependencies
        run: uv pip install --editable .

      # Node (needed for docs build)
      - name: setup node
        uses: actions/setup-node@v4
        with:
          node-version: '22.12.0'

      - name: setup pnpm
        uses: pnpm/action-setup@v4
        with:
          version: 10
          run_install: false

      - name: install docs dependencies
        run: pnpm install --prefer-frozen-lockfile
        working-directory: docs

      # Checks
      - name: verify generated docs data
        run: pnpm run check-docs-data
        working-directory: docs

      - name: build docs
        run: pnpm build
        working-directory: docs
        env:
          DEPLOY_TARGET: ${{ github.event_name == 'workflow_dispatch' && inputs.deploy_target || github.ref == 'refs/heads/main' && 'ghpages' || 'custom' }}

      # Upload artifact for deploy (main branch only)
      - name: upload pages artifact
        if: github.ref == 'refs/heads/main'
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/dist

  deploy:
    if: github.ref == 'refs/heads/main'
    needs: check-and-build
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4