Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Changelog process improvements #36334

Merged
merged 9 commits into from
Jan 16, 2025
Merged

Changelog process improvements #36334

merged 9 commits into from
Jan 16, 2025
+46 −6

Conversation

DanielMSchmidt
Copy link
Contributor

This PR solves two problems in the changelog process

  1. We only want to include experiments if we are doing an alpha release and in the dev changelog
  2. When a branch is set up for the new minor version when doing a beta we want to make sure any changes coming in to that branch via the backport process are only included in the old minor release and not the next one as well. To solve this we now have unreleased folder for changes that are not yet released in the next minor and backported folder for changes that will be backported.

Fixes #

Target Release

1.11.x

CHANGELOG entry

  • This change is user-facing and I added a changelog entry.
  • This change is not user-facing.

@DanielMSchmidt DanielMSchmidt requested a review from a team as a code owner January 15, 2025 15:52
@DanielMSchmidt
add back experiments
da0cfec
@DanielMSchmidt
only include experiments in dev and alpha releases
ac5036a
@DanielMSchmidt
setup script for maintenance branch
455f12a 
By changing the folder changie uses for the changelog we can
make sure that users can put the changelog entries into a specific
folder based on if the change will be backported. This way it will
only appear in the patch release of the maintenance branch and not
in the changelog of the current development branch.
@DanielMSchmidt
add backported comment to PR template
8244025
@DanielMSchmidt
remove old backported changes
53a25d7
@DanielMSchmidt DanielMSchmidt force-pushed the changelog-and-experiments branch from c0353b2 to 53a25d7 Compare January 15, 2025 16:01
radeksimko
radeksimko reviewed Jan 15, 2025
View reviewed changes
.changes/footer-with-experiments.md Outdated Show resolved Hide resolved
scripts/changelog.sh Outdated Show resolved Hide resolved
SarahFrench
SarahFrench reviewed Jan 15, 2025
View reviewed changes
scripts/changelog.sh Outdated Show resolved Hide resolved
radeksimko
radeksimko previously approved these changes Jan 16, 2025
View reviewed changes
scripts/changelog.sh Outdated Show resolved Hide resolved
@DanielMSchmidt @radeksimko
fix typo
cff8616 
Co-authored-by: Radek Simko <[email protected]>
@DanielMSchmidt DanielMSchmidt added the 1.11-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged label Jan 16, 2025
@DanielMSchmidt DanielMSchmidt merged commit 122e5c7 into main Jan 16, 2025
11 of 12 checks passed
@DanielMSchmidt DanielMSchmidt deleted the changelog-and-experiments branch January 16, 2025 10:55
@github-actions github-actions bot mentioned this pull request Jan 16, 2025
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SarahFrench SarahFrench SarahFrench left review comments

@radeksimko radeksimko radeksimko approved these changes

Assignees
No one assigned
Labels
1.11-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@DanielMSchmidt @radeksimko @SarahFrench