Skip to content

ci(docs): generate the Kubernetes API reference at publish time #14122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dagil-nvidia merged 4 commits into from
Sep 16, 2026
Merged

ci(docs): generate the Kubernetes API reference at publish time #14122

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
009de8e
ci(docs): generate the Kubernetes API reference at publish time
dagil-nvidia Sep 1, 2026
b2cdf31
Merge main; publish the Kubernetes reference, then fail on drift
dagil-nvidia Sep 1, 2026
a00428f
Merge origin/main into publish-time-kubernetes-api-reference
dagil-nvidia Sep 3, 2026
d57150a
ci(docs): bound the regenerated reference and test the drift wiring
dagil-nvidia Sep 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions .github/workflows/fern-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,14 +141,28 @@ jobs:
# gitignored in the source tree and generated here against the exact
# ref being published, so source PRs never carry (or review) the
# regenerated MDX. Generation must precede the pages-dev sync below,
# which rsyncs whatever sits under docs/fern/pages/. The Kubernetes
# reference regenerates from a docs-owned source file and stays
# committed, so it keeps the freshness check.
# which rsyncs whatever sits under docs/fern/pages/.
#
# The Kubernetes reference stays committed, because reviewers read it
# in the PR diff, but it is REGENERATED here rather than checked. Its
# only input is the docs-owned api-reference-k8s.md sitting in this
# same checkout, so a write-mode run always produces the output the
# tagged source implies, and the rsync below publishes it.
#
# This used to be `--check`, which failed the step and so skipped the
Comment thread
dagil-nvidia marked this conversation as resolved.
Resolved
# sync and publish steps entirely. The per-PR gate is `--since`-scoped
# (pre-merge.yml) so that a branch is only failed for drift it caused,
# which is right, but it leaves merge skew uncovered: a PR that
# regenerates against main@T1 merges at T3 after another PR edited the
# source at T2, and neither PR was at fault. Main went stale and
# docs.nvidia.com silently stopped updating until somebody noticed.
# Publishing generated output removes that failure mode; the scoped
# pre-merge gate still keeps the committed copy honest for review.
run: |
python3 -m pip install 'griffe==2.1.0'
python3 source-checkout/docs/fern/scripts/gen_python_api.py
python3 source-checkout/docs/fern/scripts/gen_rust_api.py
python3 source-checkout/docs/fern/scripts/gen_kubernetes_api.py --check
python3 source-checkout/docs/fern/scripts/gen_kubernetes_api.py
Comment thread
dagil-nvidia marked this conversation as resolved.
Resolved
Comment thread
dagil-nvidia marked this conversation as resolved.
Resolved

- name: Checkout docs-website branch
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
Expand Down
Loading