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.

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

Add a tool to generate changelogs based on staged entries #2459

Closed

Conversation

JordonPhillips
Copy link
Contributor

@JordonPhillips JordonPhillips commented Nov 13, 2024

This adds a tool that generates changelogs based on staged entries. I had intended to make this pr to my own fork, so hold tight.


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

This adds a tool to generate changelog entries, similar to what some
AWS SDKs use (indeed some of the implementation is copied over). This
is being done over using jmeslog because jmeslog has somewhat
different ideas on what an entry needs. We include dates for
releases, for example.
Dataclasses are just more generally useful than a typeddict.
typeddict can easily lie to you.
This adds a tool to be used in GitHub actions that amends staged
changelog entries with the pull request number of the active pull
request if those entries don't already have them.
This adds a GitHub action that automatically adds pr links to any
changelog entries staged in the pull request.
@JordonPhillips JordonPhillips requested a review from a team as a code owner November 13, 2024 15:45
@JordonPhillips JordonPhillips changed the title Changelog tool Add a tool to generate changelogs based on staged entries Nov 13, 2024
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