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

Adds Automatic CHANGELOG.md Generation #145

Merged
merged 5 commits into from
Jan 15, 2018
Merged

Adds Automatic CHANGELOG.md Generation #145

merged 5 commits into from
Jan 15, 2018

Conversation

BugRoger
Copy link
Contributor

@BugRoger BugRoger commented Jan 2, 2018

This commits adds a Docker image that includes a tool that automatically
generates changelogs.

See: https://github.com/skywinder/github-changelog-generator

This tool relies on Github metadata to generate the Changelog. This has
the advantage that it knows more than the Git history e.g. PRs,
Labels...

The here proposed workflow is to not include the generation of the
changelog into CI, but rather manually run it for each major version.
It's easy enough:

  rm CHANGELOG.md
  make CHANGELOG.md

This commits adds a Docker image that includes a tool that automatically
generates changelogs.

See: https://github.com/skywinder/github-changelog-generator

This tool relies on Github metadata to generate the Changelog. This has
the advantage that it knows more than the Git history e.g. PRs,
Labels...

The here proposed workflow is to not include the generation of the
changelog into CI, but rather manually run it for each major version.
It's easy enough:

  rm CHANGELOG.md
  make CHANGELOG.md
@BugRoger BugRoger requested a review from databus23 as a code owner January 2, 2018 16:09
@BugRoger BugRoger changed the title Adds Automatic Changelog Generation Adds Automatic CHANGELOG.md Generation Jan 2, 2018
@BugRoger
Copy link
Contributor Author

BugRoger commented Jan 3, 2018

Needs smarter Github token handling... The token has ben automatically detected and revoked...

@databus23
Copy link
Member

databus23 commented Jan 5, 2018

Nice!

But this would also require us to do manual version bumping and in general decide how to manage versions going forward, correct?

@BugRoger
Copy link
Contributor Author

BugRoger commented Jan 5, 2018

Yes, I was thinking about aligning a minor version bump with the monthly sprints.

The changelog can pick up all tags that fit a specific regex and group by that.

@BugRoger BugRoger requested a review from edda January 12, 2018 08:27
Copy link
Contributor

@edda edda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very cool. I want something like this for Elektra as well. It requires some discipline for people to properly handle issues, pull requests etc. but that's a good thing. Also like the idea to make a new minor version per review cycle. so the changelog gets a nice grouping.

@BugRoger BugRoger merged commit c448c67 into master Jan 15, 2018
@BugRoger BugRoger deleted the changelog branch January 15, 2018 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants