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

Adopt towncrier to manage CHANGELOG updates #477

Open
pradyunsg opened this issue Oct 29, 2021 · 3 comments
Open

Adopt towncrier to manage CHANGELOG updates #477

pradyunsg opened this issue Oct 29, 2021 · 3 comments

Comments

@pradyunsg
Copy link
Member

I've missed updating the changelog entries for a release twice now. It's probably a good idea to now update our processes to avoid that mode of failure.

@pradyunsg pradyunsg changed the title Adopt towncrier to manage newfile changes Adopt towncrier to manage CHANGELOG updates Oct 29, 2021
@brettcannon
Copy link
Member

There's also scriv (it's what I use to automate the Python Launcher for Unix).

Otherwise GitHub now has automatic release notes generation that we could use instead.

@pradyunsg
Copy link
Member Author

pradyunsg commented Oct 29, 2021

I'm not a 100% sure how we'd use GitHub's generation with https://packaging.pypa.io/en/latest/changelog.html.

Although, I'm also fine with just dropping that in favour of GitHub's releases page.

@brettcannon
Copy link
Member

I think there are two options (and you touched on one of them).

One, don't worry about having an accumulated file and just point people at the releases to see what changed (as you suggested).

Two, use https://docs.github.com/en/rest/reference/repos#generate-release-notes-content-for-a-release to automatically update the changelog as part of the release.

I'm personally fine with option 1 since that's the easiest for us and contributors. 😁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants