Skip to content

Migrate release notes to per-PR fragments #2353

Open

Description

@prestist

Background

Release notes for the Upcoming release are currently edited directly in docs/release-notes.md, so concurrent PRs touching that file produce review conflicts and rebase churn. We're moving to a fragment-based workflow:

  • Each PR with a user-visible change adds a small Markdown fragment under docs/release-notes.d/, named <slug>.<category>.md.
  • PR-time CI requires a fragment (or the skip-notes label) and validates its name and contents.
  • At release time, the release-notes tool folds fragments into the Upcoming section of docs/release-notes.md, scaffolds the next Upcoming section, and deletes the consumed fragments. PR links are derived from Git history, not manual bookkeeping.

Rollout status

Supporting work already merged:

Follow-ups

Once #2347 and #2352 land, this can be closed; remaining follow-ups can move to their own issues if still relevant.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    jirafor syncing to jira

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions