Skip to content

Seed the changelog backports scaffold when cutting a stable branch - #14744

Merged
cderv merged 1 commit into
mainfrom
docs/changelog-backport-scaffold
Jul 31, 2026
Merged

Seed the changelog backports scaffold when cutting a stable branch#14744
cderv merged 1 commit into
mainfrom
docs/changelog-backport-scaffold

Conversation

@cderv

@cderv cderv commented Jul 31, 2026

Copy link
Copy Markdown
Member

While backporting #14742 to the v1.10 stable branch, the changelog entry had nowhere correct to land. Stable branches carry a # v{next} backports section to hold backported entries (v1.9 has # v1.10 backports), but v1.10 was cut without it — so the entry would otherwise be mis-filed under ## Regression fixes, a frozen section that tracks the previous version's own release fixes, not backports.

The scaffold was missing because nothing in the release process seeds it. This adds a branch-cut step to create it, and aligns the backport checklist, the stable patch-release checklist, and the changelog rule so they all refer to the same sections.

A stable branch's changelog needs the `# v{next} backports` heading
(with `## In this release` / `## In previous releases`) plus a
`# v{this} changes` wrapper so backported PRs have a place to land and
the monthly patch release has entries to demote. The current stable
v1.10 branch was cut without that scaffold, so a backport had nowhere
correct to go and risked being mis-filed under the frozen
`## Regression fixes` (which tracks the previous version's own release
fixes, not backports).

Add the seed step to the branch-creation checklist, and make the
backport checklist, the stable patch-release checklist, and the
changelog rule all reference the scaffold explicitly so the section
names stay consistent across docs.
@posit-snyk-bot

posit-snyk-bot commented Jul 31, 2026

Copy link
Copy Markdown
Collaborator

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@cderv
cderv merged commit 55389ba into main Jul 31, 2026
10 checks passed
@cderv
cderv deleted the docs/changelog-backport-scaffold branch July 31, 2026 16:53
cderv added a commit that referenced this pull request Jul 31, 2026
Cutting and patching the v1.10 stable release surfaced a batch of
release-checklist and backport-doc improvements that landed on main:
pre-branch checks, merge-step learnings, the changelog backports-scaffold
convention (#14744), and the /make-release skill. The v1.10 branch is the
one these docs are exercised on when backporting and cutting patch
releases, so bring its copies in step with main rather than leaving them
frozen at branch-cut.
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.

2 participants