FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
sdk-python/.github/workflows/docs.yml at main · durable-workflow/sdk-python · GitHub
Uh oh!
There was an error while loading.
Please reload this page
.
durable-workflow
/
sdk-python
Public
Notifications
You must be signed in to change notification settings
Fork
0
Star
1
Code
Issues
0
Pull requests
0
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
sdk-python
/
.github
/
workflows
/
docs.yml
Copy path
View runs
More file actions
More file actions
Latest commit
History
History
History
377 lines (350 loc) · 14.7 KB
Breadcrumbs
sdk-python
/
.github
/
workflows
/
docs.yml
Copy path
File metadata and controls
377 lines (350 loc) · 14.7 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
name
:
Docs deployment
run-name
:
>-
${{ github.event_name == 'workflow_dispatch'
&& format('Deploy Python release docs {0}@{1} from release run {2}.{3}',
inputs.release_version, inputs.release_source_sha, inputs.release_run_id, inputs.release_run_attempt)
|| format('Deploy Python docs from main@{0}', github.sha) }}
on
:
push
:
branches
:
[main]
paths
:
-
'
src/**
'
-
'
docs/**
'
-
'
overrides/**
'
-
'
mkdocs.yml
'
-
'
pyproject.toml
'
-
'
scripts/ci/classify_docs_visual_changes.py
'
-
'
scripts/ci/test-classify-docs-visual-changes.py
'
-
'
scripts/ci/validate-release-docs-source.py
'
-
'
scripts/api_reference_release.py
'
-
'
scripts/check_api_reference_install.py
'
-
'
scripts/check-docs-analytics.py
'
-
'
scripts/check-docs-layout.py
'
-
'
scripts/docstring_cross_references.py
'
-
'
scripts/mkdocs_hooks.py
'
-
'
scripts/qualify-docs-promotion.py
'
-
'
.github/workflows/docs.yml
'
-
'
.github/workflows/docs-pr.yml
'
-
'
.github/workflows/docs-visual.yml
'
workflow_dispatch
:
inputs
:
release_version
:
description
:
Exact public PyPI version and immutable source tag.
required
:
true
type
:
string
release_source_sha
:
description
:
Exact release source commit to render and audit.
required
:
true
type
:
string
release_parent_sha
:
description
:
Exact first parent of the release source commit.
required
:
true
type
:
string
release_run_id
:
description
:
Authenticated publication workflow run requesting this deployment.
required
:
true
type
:
string
release_run_attempt
:
description
:
Exact attempt of the publication workflow run.
required
:
true
type
:
string
permissions
:
contents
:
read
concurrency
:
group
:
docs-deployment
cancel-in-progress
:
false
jobs
:
build
:
runs-on
:
ubuntu-latest
outputs
:
release_ready
:
${{ steps.public_install.outputs.release_ready }}
release_version
:
${{ steps.source.outputs.release_version }}
source_base_revision
:
${{ steps.source.outputs.base_revision }}
source_revision
:
${{ steps.source.outputs.revision }}
steps
:
-
name
:
Checkout the trusted main-context workflow controller
uses
:
actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803
#
v6
with
:
persist-credentials
:
false
path
:
controller
ref
:
${{ github.sha }}
-
name
:
Checkout the exact documentation source
uses
:
actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803
#
v6
with
:
fetch-depth
:
0
persist-credentials
:
false
path
:
candidate
ref
:
${{ github.event_name == 'workflow_dispatch' && inputs.release_source_sha || github.sha }}
-
uses
:
actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1
#
v6
with
:
python-version
:
"
3.12
"
-
name
:
Validate and record the deployment source identity
id
:
source
env
:
EVENT_BEFORE
:
${{ github.event.before }}
EVENT_NAME
:
${{ github.event_name }}
RELEASE_PARENT_SHA
:
${{ inputs.release_parent_sha }}
RELEASE_RUN_ATTEMPT
:
${{ inputs.release_run_attempt }}
RELEASE_RUN_ID
:
${{ inputs.release_run_id }}
RELEASE_SOURCE_SHA
:
${{ inputs.release_source_sha }}
RELEASE_VERSION
:
${{ inputs.release_version }}
WORKFLOW_REF
:
${{ github.ref }}
WORKFLOW_SHA
:
${{ github.sha }}
run
:
|
set -euo pipefail
if [ "$WORKFLOW_REF" != refs/heads/main ]; then
printf 'docs deployment workflow must execute from refs/heads/main, got %s\n' "$WORKFLOW_REF" >&2
exit 1
fi
observed_source="$(git -C candidate rev-parse HEAD)"
if [ "$EVENT_NAME" = workflow_dispatch ]; then
for identity in "$RELEASE_RUN_ID" "$RELEASE_RUN_ATTEMPT"; do
if [[ ! "$identity" =~ ^[1-9][0-9]*$ ]]; then
printf 'release workflow run identity is invalid\n' >&2
exit 1
fi
done
python controller/scripts/ci/validate-release-docs-source.py \
--repo-root candidate \
--source-sha "$RELEASE_SOURCE_SHA" \
--parent-sha "$RELEASE_PARENT_SHA" \
--release-version "$RELEASE_VERSION"
source_revision="$RELEASE_SOURCE_SHA"
base_revision="$RELEASE_PARENT_SHA"
release_version="$RELEASE_VERSION"
elif [ "$EVENT_NAME" = push ]; then
if [ "$observed_source" != "$WORKFLOW_SHA" ]; then
printf 'main docs checkout is %s, expected event commit %s\n' "$observed_source" "$WORKFLOW_SHA" >&2
exit 1
fi
source_revision="$observed_source"
base_revision="$EVENT_BEFORE"
release_version="$(python -c \
'import tomllib; print(tomllib.load(open("candidate/pyproject.toml", "rb"))["project"]["version"])')"
else
printf 'docs deployment does not accept event %s\n' "$EVENT_NAME" >&2
exit 1
fi
if [[ ! "$source_revision" =~ ^[0-9a-f]{40}$ ]] ||
[[ ! "$base_revision" =~ ^[0-9a-f]{40}$ ]]; then
printf 'docs deployment source identities must be exact Git object IDs\n' >&2
exit 1
fi
{
printf 'revision=%s\n' "$source_revision"
printf 'base_revision=%s\n' "$base_revision"
printf 'release_version=%s\n' "$release_version"
} >> "$GITHUB_OUTPUT"
-
name
:
Install package + docs deps
working-directory
:
candidate
run
:
pip install -e '.[docs]'
-
name
:
Install browser for responsive layout checks
working-directory
:
candidate
run
:
python -m playwright install --with-deps chromium
-
name
:
Build site
working-directory
:
candidate
env
:
CLOUDFLARE_WEB_ANALYTICS_TOKEN
:
${{ vars.CLOUDFLARE_WEB_ANALYTICS_TOKEN }}
SOURCE_REVISION
:
${{ steps.source.outputs.revision }}
run
:
|
python scripts/ci/test-classify-docs-visual-changes.py
mkdocs build --strict
python scripts/docstring_cross_references.py --site site
python scripts/check_api_reference_install.py --site site
python scripts/check-docs-analytics.py site
python scripts/check-docs-layout.py site
if [ "$GITHUB_SERVER_URL" = https://github.com ]; then
if ! printf '%s' "$CLOUDFLARE_WEB_ANALYTICS_TOKEN" | grep -Eq '^[a-f0-9]{32}$'; then
echo 'CLOUDFLARE_WEB_ANALYTICS_TOKEN must be the canonical 32-character site token' >&2
exit 1
fi
sed -i "s/__CLOUDFLARE_WEB_ANALYTICS_TOKEN__/$CLOUDFLARE_WEB_ANALYTICS_TOKEN/" \
docs/javascripts/analytics.js
mkdocs build --strict
python scripts/docstring_cross_references.py --site site
python scripts/check_api_reference_install.py --site site
python scripts/check-docs-analytics.py site --require-token
fi
python scripts/check_api_reference_install.py \
--site site \
--source-revision "$SOURCE_REVISION"
-
name
:
Verify the rendered command against public PyPI
id
:
public_install
if
:
${{ github.server_url == 'https://github.com' }}
working-directory
:
candidate
env
:
PUBLISHED_RELEASE
:
${{ github.event_name == 'workflow_dispatch' }}
run
:
|
arguments=(--site site --install)
if [ "$PUBLISHED_RELEASE" = true ]; then
python scripts/check_api_reference_install.py "${arguments[@]}"
else
set +e
python scripts/check_api_reference_install.py \
"${arguments[@]}" \
--install-attempts 1 \
--install-retry-sleep 0 \
--unavailable-exit-code 75
status="$?"
set -e
if [ "$status" -eq 75 ]; then
printf 'release_ready=false\n' >> "$GITHUB_OUTPUT"
printf '::notice title=API reference preserved::The exact SDK release is not yet public on PyPI.\n'
exit 0
fi
if [ "$status" -ne 0 ]; then
exit "$status"
fi
fi
printf 'release_ready=true\n' >> "$GITHUB_OUTPUT"
-
name
:
Upload GitHub Pages artifact
if
:
>-
github.server_url == 'https://github.com' &&
steps.public_install.outputs.release_ready == 'true'
uses
:
actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9
#
v5
with
:
path
:
candidate/site
visual-evidence
:
needs
:
build
uses
:
./.github/workflows/docs-visual.yml
#
local
with
:
source_base_sha
:
${{ needs.build.outputs.source_base_revision }}
source_ref
:
${{ needs.build.outputs.source_revision }}
permissions
:
contents
:
read
deploy
:
needs
:
[build, visual-evidence]
if
:
>-
github.server_url == 'https://github.com' &&
github.ref == 'refs/heads/main' &&
needs.build.outputs.release_ready == 'true' &&
(github.event_name == 'push' || github.event_name == 'workflow_dispatch')
runs-on
:
ubuntu-latest
outputs
:
page_url
:
${{ steps.deployment.outputs.page_url }}
source_revision
:
${{ steps.evidence.outputs.source_revision }}
permissions
:
contents
:
read
id-token
:
write
pages
:
write
environment
:
name
:
github-pages
url
:
${{ steps.deployment.outputs.page_url }}
steps
:
-
id
:
deployment
uses
:
actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128
#
v5
-
name
:
Record the deployed public source revision
id
:
evidence
env
:
DEPLOYED_REVISION
:
${{ needs.build.outputs.source_revision }}
DEPLOYMENT_URL
:
${{ steps.deployment.outputs.page_url }}
RELEASE_VERSION
:
${{ needs.build.outputs.release_version }}
run
:
|
printf 'source_revision=%s\n' "$DEPLOYED_REVISION" >> "$GITHUB_OUTPUT"
{
printf '## Python API reference deployed\n\n'
printf -- '- SDK version: `%s`\n' "$RELEASE_VERSION"
printf -- '- Source revision: `%s`\n' "$DEPLOYED_REVISION"
printf -- '- Public URL: %s\n' "$DEPLOYMENT_URL"
} >> "$GITHUB_STEP_SUMMARY"
qualify-promotion
:
needs
:
[build, deploy]
if
:
${{ needs.deploy.result == 'success' }}
runs-on
:
ubuntu-latest
permissions
:
contents
:
read
steps
:
-
uses
:
actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803
#
v6
with
:
persist-credentials
:
false
ref
:
${{ needs.build.outputs.source_revision }}
-
uses
:
actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1
#
v6
with
:
python-version
:
"
3.12
"
-
name
:
Install browser qualification dependencies
run
:
|
pip install -e '.[docs]'
python -m playwright install --with-deps chromium
-
name
:
Qualify deployed landing and promotion transport
run
:
>-
python scripts/qualify-docs-promotion.py
--source-revision "${{ needs.build.outputs.source_revision }}"
--evidence-directory deployed-visual
-
name
:
Retain deployed landing evidence
if
:
always()
uses
:
actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a
#
v7
with
:
name
:
python-docs-deployed-${{ needs.build.outputs.source_revision }}
path
:
deployed-visual
if-no-files-found
:
warn
retention-days
:
30
audit-release
:
needs
:
[build, deploy]
if
:
${{ github.event_name == 'workflow_dispatch' }}
runs-on
:
ubuntu-latest
steps
:
-
name
:
Checkout the trusted main-context workflow controller
uses
:
actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803
#
v6
with
:
persist-credentials
:
false
path
:
controller
ref
:
${{ github.sha }}
-
name
:
Checkout the exact audited release source
uses
:
actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803
#
v6
with
:
persist-credentials
:
false
path
:
candidate
ref
:
${{ needs.build.outputs.source_revision }}
-
uses
:
actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1
#
v6
with
:
python-version
:
"
3.12
"
-
name
:
Build and exercise the API-reference install path
working-directory
:
candidate
run
:
|
pip install -e '.[docs]'
mkdocs build --strict
python scripts/docstring_cross_references.py --site site
python ../controller/scripts/check_api_reference_install.py \
--repo-root . \
--site site \
--install
-
name
:
Verify the deployed API-reference release record
working-directory
:
candidate
env
:
DEPLOYED_REVISION
:
${{ needs.deploy.outputs.source_revision }}
EXPECTED_REVISION
:
${{ needs.build.outputs.source_revision }}
RELEASE_VERSION
:
${{ needs.build.outputs.release_version }}
run
:
|
if [ "$DEPLOYED_REVISION" != "$EXPECTED_REVISION" ]; then
printf 'deployed revision %s does not match release revision %s\n' \
"$DEPLOYED_REVISION" "$EXPECTED_REVISION" >&2
exit 1
fi
python ../controller/scripts/check_api_reference_install.py \
--repo-root . \
--site site \
--source-revision "$EXPECTED_REVISION" \
--verify-deployed-url https://python.durable-workflow.com/release-audit.json
{
printf '## Python API reference release audit passed\n\n'
printf -- '- SDK release: `%s`\n' "$RELEASE_VERSION"
printf -- '- Source revision: `%s`\n' "$EXPECTED_REVISION"
printf -- '- Release evidence: https://python.durable-workflow.com/release-audit.json\n'
} >> "$GITHUB_STEP_SUMMARY"
-
name
:
Verify live docs release audit after PyPI publish
env
:
DOCS_RELEASE_AUDIT_ARTIFACT
:
sdk-python
DOCS_RELEASE_AUDIT_VERSION
:
${{ needs.build.outputs.release_version }}
DOCS_RELEASE_AUDIT_EVIDENCE
:
docs-release-audit-evidence.json
DOCS_RELEASE_AUDIT_HANDOFF
:
docs-release-audit-handoff.json
DOCS_RELEASE_AUDIT_ENFORCEMENT
:
advisory
run
:
controller/scripts/ci/check-docs-release-audit.sh
-
name
:
Upload docs release audit evidence
if
:
always()
uses
:
actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a
#
v7
with
:
name
:
docs-release-audit-evidence-${{ needs.build.outputs.release_version }}
path
:
|
docs-release-audit-evidence.json
docs-release-audit-handoff.json
if-no-files-found
:
warn
Back
|
FazBrowse Home
|
New Git URL