Skip to content

[docs] feat: add cherrypick policy for release branches - #3739

Merged
ko3n1g merged 7 commits into
mainfrom
ko3n1g/docs/cherrypick-policy
May 9, 2026
Merged

[docs] feat: add cherrypick policy for release branches#3739
ko3n1g merged 7 commits into
mainfrom
ko3n1g/docs/cherrypick-policy

Conversation

@ko3n1g

@ko3n1g ko3n1g commented May 7, 2026

Copy link
Copy Markdown
Contributor
Claude summary

What

Adds docs/releases/cherrypick-policy.md — a single source of truth for what may land on the Megatron-LM and Megatron-Bridge release branches between branch cut and release. Cross-links the new doc from docs/releases/README.md and the Code-Freeze section of docs/releases/release-process.md.

Why

Today, decisions about what can be cherrypicked onto a release branch during code-freeze are made ad-hoc. The new doc:

  • Codifies two phases: code-freeze (10 business days, Mon → Fri of the following week) and an absolute freeze that runs from end of code-freeze to release day.
  • Defines scope: source code (incl. tutorials/examples) is "fixes only" during code-freeze; performance scripts and documentation may continue to merge during code-freeze and stop being acceptable in the absolute freeze.
  • Requires blast-radius assessment for every Phase 1 fix and rejects confirmed breaking changes.
  • Names a single waiving authority for cherrypicks onto release branches. The role is currently held by the automation team, but the policy is written so that ownership can move without rewriting the rule. Code review, blast-radius assessment, and QA recommendations are inputs to the waiving authority's decision, never substitutes for it.

Quick reference

Window Source code (MLM + MBridge, incl. tutorials/examples) Performance scripts Documentation
Code-freeze (Phase 1) Fixes only; blast-radius assessed; confirmed breaking changes rejected Allowed Allowed
Absolute freeze (Phase 2) QA / automation-recommended only QA / automation-recommended only QA / automation-recommended only

Files

  • docs/releases/cherrypick-policy.md — new doc.
  • docs/releases/README.md — index row + Quick Navigation entry.
  • docs/releases/release-process.md — one-line cross-link in the Code-Freeze section.

Document what may land on Megatron-LM and Megatron-Bridge release
branches between branch cut and release. Defines two phases
(code-freeze with fixes-only on in-scope code, absolute freeze with
QA/automation-recommended only) and clarifies that only the automation
team can waive cherrypicks. Cross-link from docs/releases/README.md
and the Code-Freeze section of release-process.md.

Signed-off-by: oliver könig <okoenig@nvidia.com>
@ko3n1g ko3n1g added docs-only With great power comes great responsibility. docs Documentation-only updates or documentation debt area:misc Cross-cutting utilities, logging, helpers, and other changes needs-review PR is ready for code review and waiting on a reviewer labels May 7, 2026
@claude

claude Bot commented May 7, 2026

Copy link
Copy Markdown
Contributor

Review

LGTM — clean docs-only PR. The new cherrypick policy is well-structured, internally consistent, and the cross-links from README.md and release-process.md are correct. A few minor observations (non-blocking):

  • The term "code-freeze" in release-process.md is used broadly (its section spans Weeks 3-7 of the cycle), while the new policy defines "Phase 1 - Code-freeze" as exactly 10 business days. The cross-link helps disambiguate, but readers going back and forth may initially be confused by the scope difference. Consider whether a parenthetical like "(the first two weeks after branch cut)" in the policy doc would help anchor it.
  • CONTRIBUTING.md link (../../CONTRIBUTING.md on line 18) resolves correctly from docs/releases/.

Suggested test cases

No perf tests impacted.

ko3n1g added 5 commits May 7, 2026 14:56
Frame the cherrypick waiver as an abstract "waiving authority" role
held today by the automation team, so the policy survives an ownership
handoff without rewording. Updates the Two Phases, Phase 2, and Quick
Reference sections to use the role-then-holder phrasing.

Signed-off-by: oliver könig <okoenig@nvidia.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>
@ko3n1g
ko3n1g requested a review from chtruong814 May 7, 2026 15:01
…IBUTING url

Sphinx --fail-on-warning treats two findings as errors:
- cherrypick-policy.md missing from any toctree.
- ../../CONTRIBUTING.md resolved as a myst xref to a non-existent doc.

Add the page to the Releases toctree in docs/index.md and switch the
CONTRIBUTING link to the GitHub URL pattern other docs already use.

Signed-off-by: oliver könig <okoenig@nvidia.com>
@ko3n1g
ko3n1g enabled auto-merge (squash) May 9, 2026 09:46
@ko3n1g
ko3n1g merged commit 8578a65 into main May 9, 2026
39 checks passed
@ko3n1g
ko3n1g deleted the ko3n1g/docs/cherrypick-policy branch May 9, 2026 14:03
gautham-kollu pushed a commit that referenced this pull request May 12, 2026
Signed-off-by: oliver könig <okoenig@nvidia.com>
vasunvidia pushed a commit to vasunvidia/Megatron-Bridge that referenced this pull request Jun 10, 2026
…3739)

Signed-off-by: oliver könig <okoenig@nvidia.com>
Signed-off-by: Vasudevan Rengasamy <vrengasamy@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:misc Cross-cutting utilities, logging, helpers, and other changes docs Documentation-only updates or documentation debt docs-only With great power comes great responsibility. needs-review PR is ready for code review and waiting on a reviewer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants