Skip to content

CHANGELOGs: don't include unreleased changed#926

Merged
RafalKorepta merged 1 commit intomainfrom
chris/p/no-unreleased-changes
Jun 20, 2025
Merged

CHANGELOGs: don't include unreleased changed#926
RafalKorepta merged 1 commit intomainfrom
chris/p/no-unreleased-changes

Conversation

@chrisseto
Copy link
Contributor

Prior to this commit all CHANGELOG.md files contained an ### unreleased section list all pending changes in changie fragments. The idea at the time was to make it easy to understand what changes would be present in an upcoming release.

In practice these sections were never referred to as most developers would rely on git log. Worse yet they were the primary cause of backports requiring manual intervention.

As the number of release branches has grown, so has the frequency of backporting and the frustration of needing to manually re-run task generate.

This commit removes the unreleased section with the primary goal of reducing the toil of backporting commits.

Prior to this commit all CHANGELOG.md files contained an `### unreleased`
section list all pending changes in changie fragments. The idea at the time was
to make it easy to understand what changes would be present in an upcoming
release.

In practice these sections were never referred to as most developers would rely
on `git log`. Worse yet they were the primary cause of backports requiring
manual intervention.

As the number of release branches has grown, so has the frequency of
backporting and the frustration of needing to manually re-run `task generate`.

This commit removes the unreleased section with the primary goal of reducing
the toil of backporting commits.
@RafalKorepta RafalKorepta force-pushed the chris/p/no-unreleased-changes branch from 56d0994 to 5d2dd76 Compare June 20, 2025 15:28
@RafalKorepta RafalKorepta enabled auto-merge (rebase) June 20, 2025 15:28
@RafalKorepta RafalKorepta merged commit 1d28958 into main Jun 20, 2025
10 checks passed
@RafalKorepta RafalKorepta deleted the chris/p/no-unreleased-changes branch June 20, 2025 16:46
@RafalKorepta
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
release/v25.1.x
release/v2.4.x
release/v2.3.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants