search

mingrammer / diagrams

:art: Diagram as Code for prototyping cloud system architectures
https://diagrams.mingrammer.com
MIT License
36.87k stars 2.39k forks source link

Automatize the changelog generation #224

Open gabriel-tessier opened 4 years ago

gabriel-tessier commented 4 years ago

As we will have a CHANGELOG file what about automatize the generation?...

Using tool like:

https://github.com/lob/generate-changelog

Need to update contribution to add the rule for the commit title.

mingrammer commented 4 years ago

Sounds good. Ye, to use a tool like that, we should enforce the commit message convention to all contributors. Let's discuss about it. Here is a link for all release changelogs: https://github.com/mingrammer/diagrams/releases

We can improve the changelogs better than now, we don't have to be tied to the current format.

louisguitton commented 4 years ago

You can also enforce PR titles instead of commit messages (it's a lot less overhead, and you can easily change them after a PR is merged etc...) and then rely on Github Actions to draft the release notes based on all merged PRs. I am a happy user of https://github.com/marketplace/actions/release-drafter