Use towncrier for release notes

furious-luke / django-address

A Django address model and field. Addresses may be specified by address components or by performing an automatic Google Maps lookup.

BSD 3-Clause "New" or "Revised" License

431 stars 181 forks source link

Use towncrier for release notes #149

Open furious-luke opened 3 years ago

furious-luke commented 3 years ago

Towncrier is a neat little project that assists in automatically preparing release notes for projects. I think it could be useful to automate this process. A couple things that we should consider:

There are precommit hooks and checks we can run to ensure PRs come with release notes.
We can add the release note collection stage to the CI pipeline.

banagale commented 3 years ago

This looks like it could be really useful. It would be better to assemble release notes as PRs are pulled in than to add weight to the end.