📝 Prepare changelog and upgrade guide at release time - #2556
Merged
Merged
Conversation
🤖 *AI text below* 🤖 Move changelog preparation out of feature and fix PRs. Remove the Unreleased section and its links while preserving published release notes. Keep migration instructions with the changes that introduce them. Regenerate contributor guidance and the PR checklist from templates#449, pin its source revision, and align Core's development and agent policies. Assisted-by: GPT-6 via Codex
This was referenced Sep 13, 2026
simon1hofmann
added a commit
that referenced
this pull request
Sep 13, 2026
🤖 *AI text below* 🤖 Remove this PR's changelog entry and reference in line with the release preparation workflow proposed in #2556. Keep the user-facing behavior and limitations documented in the PR description. Assisted-by: GPT-6 via Codex
simon1hofmann
added a commit
that referenced
this pull request
Sep 13, 2026
🤖 *AI text below* 🤖 Remove this PR's changelog entry and reference in line with the release preparation workflow proposed in #2556. Keep the user-facing behavior and limitations documented in the PR description. Assisted-by: GPT-6 via Codex
simon1hofmann
added a commit
that referenced
this pull request
Sep 13, 2026
🤖 *AI text below* 🤖 Merge the mapping-controls base update and remove the layout changelog entry and reference. Neither PR now adds changelog text; release preparation will collect their user-facing changes as proposed in #2556. Assisted-by: GPT-6 via Codex
This was referenced Sep 13, 2026
simon1hofmann
added a commit
that referenced
this pull request
Sep 13, 2026
🤖 *AI text below* 🤖 Remove this PR's upgrade-guide entry under the release documentation policy proposed in #2556. Preserve migration details in the PR description for the release maintainer to collect. Assisted-by: GPT-6 via Codex
Member
|
Let's also drop the upgrade guide and generate that on the fly in release prep PRs. |
simon1hofmann
added a commit
that referenced
this pull request
Sep 13, 2026
🤖 *AI text below* 🤖 Remove this PR's upgrade-guide entry under the release documentation policy proposed in #2556. Preserve migration details in the PR description for the release maintainer to collect. Assisted-by: GPT-6 via Codex
simon1hofmann
added a commit
that referenced
this pull request
Sep 13, 2026
🤖 *AI text below* 🤖 Merge the mapping-controls base update and remove the layout upgrade-guide entry. Both PR descriptions retain their migration details for release preparation under the policy proposed in #2556. Assisted-by: GPT-6 via Codex
🤖 *AI text below* 🤖 Prepare the upgrade guide with the changelog at release time and keep migration instructions in feature PR descriptions. Remove its empty Unreleased section, regenerate shared guidance and the PR checklist, and update the template pin. Assisted-by: GPT-6 via Codex
simon1hofmann
marked this pull request as ready for review
September 13, 2026 21:26
🤖 *AI text below* 🤖 Pin Templates #449 at merge commit 377a3dcd360ed3e4d879901dbda7d21e889f435b and regenerate the shared files. Align Core’s release policy with the merged guidance on changelog and upgrade-guide edits. Assisted-by: GPT-6 via Codex
burgholzer
approved these changes
Sep 14, 2026
burgholzer
left a comment
Member
There was a problem hiding this comment.
Just one small correction. Otherwise looks good
🤖 *AI text below* 🤖 Label the pinned template commit as main now that Templates #449 has merged. Keep the exact commit pin unchanged. Assisted-by: GPT-6 via Codex
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤖 AI text below 🤖
Description
Feature and fix PRs currently edit shared Unreleased sections, causing merge conflicts. Prepare
CHANGELOG.mdandUPGRADING.mdin release-preparation PRs. Contributors describe user-facing changes, limitations, and required migrations in their PR descriptions so release maintainers can collect them.Update Core's development policy and agent guide, and regenerate the contributor guide and PR checklist from templates #449. Remove both per-PR release-documentation checkboxes and pin the templating workflow to its merge commit
377a3dcd360ed3e4d879901dbda7d21e889f435b. Core’s own policy allows changes to these files only during release preparation or when explicitly requested.Remove the current changelog's Unreleased entries and both files' Unreleased headers and unused links. Between releases, both files contain published releases only. Release preparation gathers changes and migration instructions from Git history, merged PR descriptions, Release Drafter, and any existing notes, accounting for backports and earlier maintenance releases. The removed changelog notes concern #2537, #2544, and #2547; those PRs remain sources for the next release. The upgrade guide's v4 overview link now targets the published changelog section.
AI tools may draft release documentation; maintainers verify claims, links, attribution, and migration examples. Implements the review discussion in #2550, including preparing the upgrade guide at release time.
Validation:
uvx nox -s lintpassed.This is a documentation and template update; no new runtime tests are needed. CI for the updated head remains pending. Codex drafted the changes, regenerated the template output, and ran validation.
Checklist
If PR contains AI-assisted content:
🤖 *AI text below* 🤖(titles are exempt).