generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 25
Add Simple Changelog Management #552
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.
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
Merged
Merged
Conversation
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
arandito
reviewed
Sep 8, 2025
Contributor
arandito
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Comments are mostly typos in the changelog and some minor nits.
packages/smithy-core/.changes/next-release/smithy-core-breaking-20250904131215.json
Outdated
Show resolved
Hide resolved
packages/smithy-core/.changes/next-release/smithy-core-breaking-20250904131233.json
Outdated
Show resolved
Hide resolved
packages/smithy-core/.changes/next-release/smithy-core-breaking-20250904131302.json
Outdated
Show resolved
Hide resolved
SamRemis
previously approved these changes
Sep 11, 2025
packages/smithy-aws-core/.changes/next-release/smithy-aws-core-feature-20250904125834.json
Outdated
Show resolved
Hide resolved
SamRemis
approved these changes
Sep 12, 2025
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.
Summary
Changelog entries are currently being managed manually for each smithy package. This PR includes the following changes to help automate this process and improve consistency:
CHANGES.mdtoCHANGELOG.mdnew-entry.pyscript that creates a new change entry under a package's.changes/next-releasedirectory.new-release.pyscript that consolidates all next-release changes into a permanent.changes/x.y.z.jsonfile.render.pyscript that re-renders a package's CHANGELOG.md file using all the.changes/<version>.jsonentries.Workflow Eample
This generates a file like
<package_name>/.changes/next-release/<unique_id>.jsonwith the following content:This generates a new file like
<package_name>/.changes/<version>.jsonwith all changes to be released:This command will re-render the changelog and replace the content at
<path_to_changelog>By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.