Skip to content

guide: define release branch and servicing policy - #4461

Merged
Ben Hillis (benhillis) merged 7 commits into
microsoft:mainfrom
benhillis:docs/monthly-release-process
Sep 17, 2026
Merged

Ben Hillis (benhillis) merged 7 commits into
microsoft:mainfrom
benhillis:docs/monthly-release-process

Conversation

@benhillis

@benhillis Ben Hillis (benhillis) commented Sep 15, 2026

Copy link
Copy Markdown
Member

Summary

  • establish monthly release/YYMM repository branches
  • document how OpenVMM and OpenHCL product versions relate to repository releases
  • define short-term monthly servicing and extended OpenHCL servicing
  • support the current and two preceding OpenHCL product releases
  • define OpenVMM feature and servicing version-selection rules
  • limit backports to security and critical bug fixes
  • document release-branch setup requirements

This policy applies prospectively to releases created under the new model. Existing release branches retain their currently documented lifecycle states.

Validation

  • cargo xtask fmt --fix

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 86550dd7-44d0-4200-87eb-20a0f01154e9
@benhillis
Ben Hillis (benhillis) requested a review from a team as a code owner September 15, 2026 22:11
Copilot AI lite review requested due to automatic review settings September 15, 2026 22:11
@github-actions github-actions Bot added the Guide label Sep 15, 2026
@benhillis
Ben Hillis (benhillis) marked this pull request as draft September 15, 2026 22:11

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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.

@github-actions

Copy link
Copy Markdown

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 86550dd7-44d0-4200-87eb-20a0f01154e9
Copilot AI review requested due to automatic review settings September 16, 2026 19:29

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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.tsx controls the fixed branch filters for Runs, Tests, and TestDetails (see petri/logview/README.md:124-131). Without adding the new release/<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

Comment thread Guide/src/dev_guide/contrib/release.md Outdated
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 86550dd7-44d0-4200-87eb-20a0f01154e9
Copilot AI review requested due to automatic review settings September 16, 2026 20:43

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 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 both run_filters and test_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.md explicitly allows selecting an already committed, unreleased workspace version without changing Cargo.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
Copilot AI review requested due to automatic review settings September 17, 2026 15:50
@benhillis

Copy link
Copy Markdown
Member Author

Addressed the latest review feedback in eb789be: corrected the unpublished-version selection wording and added the petri/logview/src/branch_quick_filters.tsx update to the release-branch checklist.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation is consistent with the repository’s release, labeling, filtering, and source-versioning processes.

Review details
  • 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
Copilot AI review requested due to automatic review settings September 17, 2026 16:30
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 86550dd7-44d0-4200-87eb-20a0f01154e9

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation changes are internally consistent and match the repository’s release, labeling, and logview conventions.

Review details
  • 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
Copilot AI review requested due to automatic review settings September 17, 2026 16:44
@benhillis Ben Hillis (benhillis) changed the title guide: document monthly release branches guide: define release branch and servicing policy Sep 17, 2026
@benhillis
Ben Hillis (benhillis) marked this pull request as ready for review September 17, 2026 16:46

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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

@benhillis
Ben Hillis (benhillis) merged commit e7de393 into microsoft:main Sep 17, 2026
146 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants