Skip to content

feat(release): forward docs-no-extras through release-library#473

Merged
ko3n1g merged 1 commit into
mainfrom
ko3n1g/feat/docs-no-extras
May 9, 2026
Merged

feat(release): forward docs-no-extras through release-library#473
ko3n1g merged 1 commit into
mainfrom
ko3n1g/feat/docs-no-extras

Conversation

@ko3n1g

@ko3n1g ko3n1g commented May 9, 2026

Copy link
Copy Markdown
Contributor
Claude summary

Why

_build_docs.yml already accepts no-extras (used to skip optional extras like --no-extra cu12 when running uv sync --all-groups). _release_library.yml exposes docs-sync-all as of v1.1.0 but does not forward a no-extras equivalent — so consumers calling the release library cannot get parity with their standalone build-docs.yml.

Discovered while migrating NVIDIA-NeMo/NeMo to call _release_library@v1.x from a single release.yml: the existing build-docs.yml there uses both sync-all: true and no-extras: "--no-extra cu12", but the release-library path drops no-extras and falls back to a full --all-extras sync, which fails to install on the docs runner.

What

  • Add a docs-no-extras input on _release_library.yml (forwards to _release_finalize.yml).
  • Add a docs-no-extras input on _release_finalize.yml (forwards to _build_docs.yml's no-extras).
  • Mirrors the existing docs-sync-all wiring exactly. No change to defaults — empty string preserves current behavior.
# example consumer (NeMo release.yml)
uses: NVIDIA-NeMo/FW-CI-templates/.github/workflows/_release_library.yml@<this-tag>
with:
  ...
  docs-sync-all: true
  docs-no-extras: "--no-extra cu12"

Test plan

Adds a docs-no-extras input on _release_library.yml and _release_finalize.yml
that forwards to _build_docs.yml's no-extras, mirroring the existing
docs-sync-all wiring. Lets consumers skip optional extras (e.g.
'--no-extra cu12') when syncing all dependency groups for the docs build.

Signed-off-by: oliver könig <okoenig@nvidia.com>
ko3n1g added a commit to ko3n1g/NeMo that referenced this pull request May 9, 2026
This reverts commit 1a75e0b.

_release_library.yml@v1.0.0 does not expose sync-all/no-extras inputs.
Forwarding is added in NVIDIA-NeMo/FW-CI-templates#473; once that lands
and gets tagged, bump the pin here and re-add the inputs as
docs-sync-all / docs-no-extras.

Signed-off-by: oliver könig <okoenig@nvidia.com>
@ko3n1g ko3n1g merged commit 0680019 into main May 9, 2026
5 checks passed
@ko3n1g ko3n1g deleted the ko3n1g/feat/docs-no-extras branch May 9, 2026 09:40
ko3n1g added a commit to ko3n1g/NeMo that referenced this pull request May 9, 2026
…extras

v1.2.0 of NVIDIA-NeMo/FW-CI-templates#473 forwards docs-no-extras (and the
existing docs-sync-all) to _build_docs.yml, so the release path can now
match build-docs.yml (sync all groups, skip the cu12 extra).

Signed-off-by: oliver könig <okoenig@nvidia.com>
ko3n1g added a commit to NVIDIA-NeMo/NeMo that referenced this pull request May 11, 2026
* ci: consolidate PR + release workflows; use validate-only

Adopts the FW-CI-templates v1.0.0 pattern (NVIDIA-NeMo/FW-CI-templates#466):
- single release.yml caller for both push (validate-only) and
  workflow_dispatch (real release / dry-run)
- one pin governs PR rehearsal and shipped release
- drops PAT/SSH_KEY/SSH_PWD secrets (App-only auth)
- bumps FW-CI pin from v0.80.3 to current SHA

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>

* ci(release): silence check-wheel-contents W005+W009 (common+multi toplevel)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>

* refactor(release): bump FW-CI pin to f5224c1; skip-check-manifest

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>

* ci(release): add pre-flight gate to skip on deploy-release/* + docs-only

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>

* ci(release): enable docs publish in release pipeline

Why: previous workflow defaulted publish-docs to false. Validate-only
runs skipped build-docs/publish-docs entirely, so the docs path was
never exercised at PR time. Default to true and surface
docs-target-path / publish-as-latest / run-on-version-tag-only.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>

* ci(release): wire docs-directory=docs/source + docs-requirements-file

Why: NeMo's Sphinx conf.py lives at docs/source/conf.py (not docs/);
docs deps install via pip, not uv (requirements/requirements_docs.txt);
fail-on-warning disabled because the existing docs tree has known
warnings that can't all be resolved at once.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>

* ci(release): bump pin + docs-skip-linkcheck

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>

* ci(changelog): bump FW-CI pin (HYBRID mode default) + add cp-title transformer

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>

* refactor(release): bump FW-CI pin to b57ebf9 ([skip ci] on bump commit)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>

* refactor(release): bump FW-CI pin to cb5e93b

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>

* refactor(release): bump FW-CI pin to 43d259e + drop SLACK_WEBHOOK passthrough

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>

* ci: bump FW-CI pin to d2f3dd3 + use secrets inherit

Lets env-scoped SLACK_WEBHOOK reach the notify job in the called workflow.

Signed-off-by: oliver könig <okoenig@nvidia.com>

* ci: strip orphan secret keys after secrets inherit

Signed-off-by: oliver könig <okoenig@nvidia.com>

* ci: bump FW-CI pin to 64293f6 (slack render fix)

Signed-off-by: oliver könig <okoenig@nvidia.com>

* ci: pin FW-CI templates to v1.0.0

Signed-off-by: oliver könig <okoenig@nvidia.com>

* ci: pragma allowlist secret on 'secrets: inherit' lines

Signed-off-by: oliver könig <okoenig@nvidia.com>

* ci: simplify release-summary if-block (always() was dead code)

Signed-off-by: oliver könig <okoenig@nvidia.com>

* ci: simplify release if-block (replace explicit success/skipped with !failure)

Signed-off-by: oliver könig <okoenig@nvidia.com>

* ci: drop docs-fail-on-warning: false (treat warnings as errors)

Signed-off-by: oliver könig <okoenig@nvidia.com>

* ci: pass sync-all and no-extras to docs build

Signed-off-by: oliver könig <okoenig@nvidia.com>

* Revert "ci: pass sync-all and no-extras to docs build"

This reverts commit 1a75e0b.

_release_library.yml@v1.0.0 does not expose sync-all/no-extras inputs.
Forwarding is added in NVIDIA-NeMo/FW-CI-templates#473; once that lands
and gets tagged, bump the pin here and re-add the inputs as
docs-sync-all / docs-no-extras.

Signed-off-by: oliver könig <okoenig@nvidia.com>

* ci: bump _release_library to v1.2.0 and pass docs-sync-all / docs-no-extras

v1.2.0 of NVIDIA-NeMo/FW-CI-templates#473 forwards docs-no-extras (and the
existing docs-sync-all) to _build_docs.yml, so the release path can now
match build-docs.yml (sync all groups, skip the cu12 extra).

Signed-off-by: oliver könig <okoenig@nvidia.com>

---------

Signed-off-by: oliver könig <okoenig@nvidia.com>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant