Skip to content

Update changelog renderer #2713

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Update changelog renderer #2713

wants to merge 7 commits into from

Conversation

JordonPhillips
Copy link
Contributor

This updates the changelog tool in several ways:

  • It updates the build backend to uv since that's what we're using as the build frontend
  • Renames the implementation namespace from tool to smithy_changelog
  • Updates render
    • To use - for changelog entry lists
    • To run a formatter on the output
    • To ensure there's space between the entry description and pr list
    • To use Smithy Changelog as the default title, with the title now being configurable
    • To ensure that additional paragraphs in an entry are properly indented (as in version 1.18.0 for instance)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

This changes the build backend for the changelog tool to uv,
which is what we're using to manage the project anyway. The
project was also renamed to `smithy_changelog` to be more
explicit, and the module name was also renamed.
Some version bumps really do need to be special cased, such as the
1.0.0 bump. This adds support in the rendering tool for those cases
by allowing their release file to be a hand-written markdown doc.
This updates the default changelog title and makes it configurable.
@JordonPhillips JordonPhillips requested a review from a team as a code owner July 23, 2025 11:50
@JordonPhillips JordonPhillips requested review from milesziemer and sugmanue and removed request for haydenbaker and milesziemer July 23, 2025 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant