dotenv-linter icon indicating copy to clipboard operation
dotenv-linter copied to clipboard

Automatic changelog adding of new commits on merge in master

Open mstruebing opened this issue 5 years ago • 6 comments

Currently, everyone needs to add their changes themselves to the CHANGELOG.md file. As this is tedious work it would be great if that could be automated via a github action on merge in master or something like that.

mstruebing avatar Oct 22 '20 10:10 mstruebing

That would be really very helpful! :+1: I already thought about this, the only thing is not always clear how to automatically classify PR (Added / Changed) :thinking:

In fact, this can be done even at the stage of the release build, in order to avoid unnecessary bot commits(per each PR) and line conflicts, writing the entire block of changes at once.

DDtKey avatar Oct 22 '20 10:10 DDtKey

the only thing is not always clear how to automatically classify PR (Added / Changed)

That would mean we need to introduce some commit guidelines, which wouldn't be so bad I think. On the other hand: If the commit message is clear enough, maybe it would be enough to have only a list of commits in the changelog between the versions, but I'm not sure. Any other ideas?

mstruebing avatar Oct 22 '20 10:10 mstruebing

I already thought about this, the only thing is not always clear how to automatically classify PR (Added / Changed) 🤔

There are two options to do that:

  1. Follows Conventional Commits rules and uses prefixes: feat and fix in commits. To ensure that contributors follow these rules we can add the commitlint.
  2. Uses labels like feature and changes.

I like more the first option. What do you think?

mgrachev avatar Oct 22 '20 13:10 mgrachev

In fact, this can be done even at the stage of the release build, in order to avoid unnecessary bot commits(per each PR) and line conflicts, writing the entire block of changes at once.

I would think more how to implement this one, because I wouldn't like to have a lot of bot commits 😅

mgrachev avatar Oct 22 '20 13:10 mgrachev

I personally like conventional commits :)

mstruebing avatar Oct 22 '20 14:10 mstruebing

I also actively use conventional commits in other projects, so I would gladly vote for this idea 🙂

DDtKey avatar Oct 22 '20 16:10 DDtKey