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

Thoughts on auto-generating changelog? #2205

Open
cyrus01337 opened this issue Nov 21, 2024 · 1 comment
Open

Thoughts on auto-generating changelog? #2205

cyrus01337 opened this issue Nov 21, 2024 · 1 comment

Comments

@cyrus01337
Copy link

I noticed that the most recent release (1.0rc at the time of writing) had a lot of changes, but there was understandably a lot more that could be reasonably tracked. What if the changelog could be automatically generated based on PRs?

It could be setup via GitHub Actions in a new workflow file and I'd be happy to assist with setting this up myself to reduce any potential friction for other collaborators moving forward. I didn't see any prior discussions on this when sifting through issues so hoping this is a first.

Thoughts?

@RSDuck
Copy link
Member

RSDuck commented Nov 21, 2024

Wouldn't that be just be basically this: 0.9.5...1.0rc ?

I think one problem would be that the individual commits are sometimes not really understandable to outside people, as often multiple commits form a more abstract feature which is later improved or fixed. Back and forth changes like fixing regressions from the last release are also part of the commit log but are completely irrelevant to the version changelog.

The best solution would probably to maintain the changelog as one goes along with development. But we lack the discipline for that.

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

No branches or pull requests

2 participants