guide: define release branch and servicing policy - #4461
Ben Hillis (benhillis) merged 7 commits into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 86550dd7-44d0-4200-87eb-20a0f01154e9
There was a problem hiding this comment.
🟢 Approval recommended
The documentation changes are straightforward, with only a non-blocking nit noted.
Pull request overview
This pull request documents the monthly YYMM release-branch model, product-release alignment, OpenHCL servicing window, and branch-label setup.
Changes:
- Defines repository and product release relationships.
- Documents OpenHCL’s three-release servicing window.
- Adds release-label and labeler configuration guidance.
File summaries
| File | Description |
|---|---|
Guide/src/dev_guide/contrib/release.md |
Updates release-branch, servicing, and label configuration documentation. |
Review details
Suppressed comments (1)
Guide/src/dev_guide/contrib/release.md:69
- This checklist omits the repository's release-branch tracking configuration. The logview README says new releases must be added to
petri/logview/src/branch_quick_filters.tsx; otherwise the branch is missing from the Runs, Tests, and TestDetails quick filters. Please add a step covering both filter arrays.
2. Add the `release_<RELEASE>` base-branch rule to `.github/labeler.yml` so pull
requests targeting the branch are labeled consistently.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 86550dd7-44d0-4200-87eb-20a0f01154e9
There was a problem hiding this comment.
🟡 Changes recommended
The release guide needs both documented corrections before approval.
Get a fresh assessment by requesting another Copilot review.
Review details
Suppressed comments (1)
Previously missed (1) — in code that hasn't changed since the last review.
Guide/src/dev_guide/contrib/release.md:80
- This checklist omits the other required release-branch setup:
petri/logview/src/branch_quick_filters.tsxcontrols the fixed branch filters for Runs, Tests, and TestDetails (seepetri/logview/README.md:124-131). Without adding the newrelease/<YYMM>branch to both filter lists, it will not be available in those views. Please document this step as well.
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 86550dd7-44d0-4200-87eb-20a0f01154e9
There was a problem hiding this comment.
🔵 Needs a closer look
The release-version guidance and logview quick-filter checklist need correction before approval.
Review details
Suppressed comments (2)
Previously missed (1) — in code that hasn't changed since the last review.
Guide/src/dev_guide/contrib/release.md:87
- The branch-creation checklist omits the required UI update in
petri/logview/src/branch_quick_filters.tsx. That file hard-codes each release branch in bothrun_filtersandtest_filters, so a newly created monthly branch will not appear in the Runs, Tests, or TestDetails quick filters unless this step is documented.
Guide/src/dev_guide/contrib/release.md:20
openvmm_source_release.mdexplicitly allows selecting an already committed, unreleased workspace version without changingCargo.toml(lines 36–39). Requiring a new globally unique SemVer here would make maintainers bump versions unnecessarily and conflicts with that documented process; describe selecting the intended unpublished version instead.
Before publishing an OpenVMM source release from `main` or a release branch,
set the workspace version to a new, globally unique SemVer in a normal pull
request. A new feature release from `main` typically increments the minor
- Files reviewed: 1/1 changed files
- Comments generated: 0 new
- Review effort level: Lite
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 86550dd7-44d0-4200-87eb-20a0f01154e9
|
Addressed the latest review feedback in eb789be: corrected the unpublished-version selection wording and added the |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 86550dd7-44d0-4200-87eb-20a0f01154e9
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 86550dd7-44d0-4200-87eb-20a0f01154e9
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 86550dd7-44d0-4200-87eb-20a0f01154e9
There was a problem hiding this comment.
🟢 Approval recommended
The documentation changes are complete, internally consistent, and align with the referenced release tooling and source-release process.
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0 new
- Review effort level: Lite
Summary
release/YYMMrepository branchesThis policy applies prospectively to releases created under the new model. Existing release branches retain their currently documented lifecycle states.
Validation
cargo xtask fmt --fix