Skip to content

cp: docs(fern): add v0.5.1 version snapshot for GA release into main - #2987

Merged
kajalj22 merged 1 commit into
mainfrom
cherry-pick-2731-main
Sep 4, 2026
Merged

cp: docs(fern): add v0.5.1 version snapshot for GA release into main#2987
kajalj22 merged 1 commit into
mainfrom
cherry-pick-2731-main

Conversation

@kajalj22

@kajalj22 kajalj22 commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Summary

Remaining stack (merge in this order): #2987#2983

Test plan

  • Confirm fern docs build picks up the new v0.5.1 version and the version switcher shows it
  • tests/unit_tests/test_fern_docs_links.py passes

@copy-pr-bot

copy-pr-bot Bot commented Sep 2, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://nvidia-preview-cherry-pick-2731-main.docs.buildwithfern.com/nemo/gym

Here are the markdown pages you've updated:

@kajalj22
kajalj22 force-pushed the cherry-pick-2731-main branch from ddccae6 to 544ac23 Compare September 2, 2026 19:18
@kajalj22
kajalj22 requested a review from a team as a code owner September 2, 2026 19:18
@kajalj22
kajalj22 changed the base branch from main to cherry-pick-2725-main September 2, 2026 19:18
kajalj22 added a commit that referenced this pull request Sep 2, 2026
…laimer (#2629) into main (#2985)

## Summary
- Cherry-pick of #2629 from `r0.5.1` into `main`. **Stack position 2 of
5** — #2547 (position 1) merged as #2986. This is now next in line,
rebased directly onto `main`.
- Adds a "Cloned and Modified Components" section to `ATTRIBUTIONS.md`
covering PinchBench (cloned & patched at image build, MIT-licensed).
- Adds the NVIDIA retrieved-materials Notice and Disclaimer to
`README.md`, required for containers that automatically retrieve
external materials at runtime.
- Addresses OSRB guidance items 10 and 11.

Remaining stack (merge in this order): #2985#2984#2987#2983

## Test plan
- [ ] Confirm ATTRIBUTIONS.md and README.md render correctly

Signed-off-by: Kajal Jain <kajalj@nvidia.com>
Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
@kajalj22
kajalj22 force-pushed the cherry-pick-2725-main branch from 9d5f552 to ed14786 Compare September 2, 2026 22:03
@github-actions github-actions Bot added the sla:triage-overdue Review assignment is over the one-business-day SLA label Sep 3, 2026
Base automatically changed from cherry-pick-2725-main to main September 4, 2026 17:27
- Snapshots `fern/versions/latest/` → `fern/versions/v0.5.1/` (97 files)
to freeze the docs at the 0.5.1 GA state
- Creates `fern/versions/v0.5.1.yml` with nav config pointing to the
frozen pages
- Registers `v0.5.1` as `stable` in `fern/docs.yml` (between Main and
0.5.0)
- Adds a v0.5.1 release notes accordion to `release-notes.mdx` in both
`latest/` and the snapshot
- Extends `test_fern_docs_links.py` version coverage to include `v0.5.1`

Follows the same pattern as the v0.5.0 snapshot (#2389). Targeted
directly at `r0.5.1` rather than `main` + cherry-pick, per direction on
this release.

`nemo_gym/package_info.py` already reports `0.5.1` with no `PRE_RELEASE`
suffix, and `pyproject.toml` derives its version from it dynamically —
no code version changes needed.

- [x] `pytest tests/unit_tests/test_fern_docs_links.py -q` — 13 passed,
20 subtests passed
- [x] Verify `docs.nvidia.com/nemo/gym` shows `0.5.1` in the version
picker as stable
- [x] Verify the v0.5.1 docs snapshot renders correctly at `/v0.5.1/`
- [x] Verify release notes page shows the v0.5.1 accordion open by
default, v0.5.0 collapsed

Signed-off-by: Kajal Jain <kajalj@nvidia.com>
@kajalj22
kajalj22 force-pushed the cherry-pick-2731-main branch from 544ac23 to 9af4491 Compare September 4, 2026 18:17
@kajalj22 kajalj22 changed the title cp: docs(fern): add v0.5.1 version snapshot for GA release (#2731) into main cp: docs(fern): add v0.5.1 version snapshot for GA release into main Sep 4, 2026
@kajalj22

kajalj22 commented Sep 4, 2026

Copy link
Copy Markdown
Contributor Author

/ok to test 9af4491

@kajalj22 kajalj22 added the r0.6.0 Auto-cherrypick to release branch. Apply before merge; cherrypick happens after merge. label Sep 4, 2026
@kajalj22
kajalj22 merged commit 4d3d647 into main Sep 4, 2026
40 checks passed
@kajalj22
kajalj22 deleted the cherry-pick-2731-main branch September 4, 2026 18:44
kajalj22 added a commit that referenced this pull request Sep 4, 2026
…main (2987)` into `r0.6.0` (#3099)

beep boop [🤖]: Hi @kajalj22 👋,

    we've cherry picked #2987 into  for you! 🚀

    Please review and approve this cherry pick by your convenience!

Signed-off-by: Kajal Jain <kajalj@nvidia.com>
Signed-off-by: NeMo Bot <nemo-bot@nvidia.com>
Co-authored-by: kajalj22 <kajalj@nvidia.com>
kajalj22 added a commit that referenced this pull request Sep 5, 2026
…laimer (#2629) into main (#2985)

## Summary
- Cherry-pick of #2629 from `r0.5.1` into `main`. **Stack position 2 of
5** — #2547 (position 1) merged as #2986. This is now next in line,
rebased directly onto `main`.
- Adds a "Cloned and Modified Components" section to `ATTRIBUTIONS.md`
covering PinchBench (cloned & patched at image build, MIT-licensed).
- Adds the NVIDIA retrieved-materials Notice and Disclaimer to
`README.md`, required for containers that automatically retrieve
external materials at runtime.
- Addresses OSRB guidance items 10 and 11.

Remaining stack (merge in this order): #2985#2984#2987#2983

## Test plan
- [ ] Confirm ATTRIBUTIONS.md and README.md render correctly

Signed-off-by: Kajal Jain <kajalj@nvidia.com>
Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Kajal Jain <kajalj@nvidia.com>
jkyi-nvidia pushed a commit that referenced this pull request Sep 11, 2026
…laimer (#2629) into main (#2985)

## Summary
- Cherry-pick of #2629 from `r0.5.1` into `main`. **Stack position 2 of
5** — #2547 (position 1) merged as #2986. This is now next in line,
rebased directly onto `main`.
- Adds a "Cloned and Modified Components" section to `ATTRIBUTIONS.md`
covering PinchBench (cloned & patched at image build, MIT-licensed).
- Adds the NVIDIA retrieved-materials Notice and Disclaimer to
`README.md`, required for containers that automatically retrieve
external materials at runtime.
- Addresses OSRB guidance items 10 and 11.

Remaining stack (merge in this order): #2985#2984#2987#2983

## Test plan
- [ ] Confirm ATTRIBUTIONS.md and README.md render correctly

Signed-off-by: Kajal Jain <kajalj@nvidia.com>
Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Junkeun Yi <jkyi@nvidia.com>
jkyi-nvidia pushed a commit that referenced this pull request Sep 11, 2026
…2987)

## Summary
- Cherry-pick of #2731 from `r0.5.1` into `main`. **Stack position 4 of
5** — #2547, #2629, #2725 (positions 1-3) merged as #2986, #2985, #2984.
This is now next in line, rebased directly onto `main`.
- Adds the frozen `fern/versions/v0.5.1/` docs snapshot (and
`fern/versions/v0.5.1.yml`) for the v0.5.1 GA release, mirroring how
prior GA versions (v0.5.0, v0.4.0, ...) got their own version snapshot
in the docs site.
- Also inserts the v0.5.1 accordion into `release-notes.mdx`, between
the newer v0.6.0 entry (already on `main`) and v0.5.0.
- Note on PR title: intentionally omits `(#2731)` — the release-branch
auto-cherrypick automation (`cherry-pick-release-commit.yml`) naively
grabs the *first* `(#NNNN)` in the squash-merge commit subject to
resolve "which PR is this". Embedding the original PR number in the
title broke that lookup for #2984/#2985/#2986 (see #3091/#3092 for the
manual r0.6.0 backfills). Keeping this title number-free lets the
automation resolve the real PR (#2987) and auto-create the r0.6.0
cherry-pick.

Remaining stack (merge in this order): #2987#2983

## Test plan
- [ ] Confirm fern docs build picks up the new v0.5.1 version and the
version switcher shows it
- [ ] `tests/unit_tests/test_fern_docs_links.py` passes

Signed-off-by: Kajal Jain <kajalj@nvidia.com>
Signed-off-by: Junkeun Yi <jkyi@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

r0.6.0 Auto-cherrypick to release branch. Apply before merge; cherrypick happens after merge. sla:triage-overdue Review assignment is over the one-business-day SLA

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants