Navigation Menu

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

Automatic changelog adding of new commits on merge in master #331

Closed
mstruebing opened this issue Oct 22, 2020 · 6 comments · Fixed by #544
Closed

Automatic changelog adding of new commits on merge in master #331

mstruebing opened this issue Oct 22, 2020 · 6 comments · Fixed by #544
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@mstruebing
Copy link
Member

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 mstruebing added feature New feature or request good first issue Good for newcomers labels Oct 22, 2020
@DDtKey
Copy link
Member

DDtKey commented Oct 22, 2020

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

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.

@mstruebing
Copy link
Member Author

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?

@mgrachev
Copy link
Member

mgrachev commented Oct 22, 2020

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 mgrachev added the discussion Discussion of something label Oct 22, 2020
@mgrachev
Copy link
Member

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 😅

@mstruebing
Copy link
Member Author

I personally like conventional commits :)

@DDtKey
Copy link
Member

DDtKey commented Oct 22, 2020

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

@mgrachev mgrachev removed feature New feature or request good first issue Good for newcomers labels Nov 3, 2020
@mgrachev mgrachev added good first issue Good for newcomers help wanted Extra attention is needed and removed discussion Discussion of something labels Jan 9, 2022
@mgrachev mgrachev linked a pull request Aug 16, 2022 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Development

Successfully merging a pull request may close this issue.

3 participants