keep-a-changelog icon indicating copy to clipboard operation
keep-a-changelog copied to clipboard

Feedback Request: Generate changelog based on Yaml files

Open JDiPierro opened this issue 7 years ago • 4 comments

Hey all,

I love the Keep-A-Changelog project and the format, but I hate dealing with merge conflicts due to the Unreleased section of the changelog. To solve this issue my team started keeping changelogs in Yaml files and then 'compiling' them into a Markdown file.

We achieve this with a tiny bit of code and a docker container in the build pipeline, check it out here: https://github.com/jdipierro/changelog-generator

I'd love feedback or pull requests with improvements :)

JDiPierro avatar Feb 12 '18 19:02 JDiPierro

It is a good idea, but then there would be only one commit with the changes.. Being able to 'blame' the changelog and see who made something (and also having a summary of important commits) is a good feature

aryelgois avatar Mar 02 '18 23:03 aryelgois

I really like the idea. Even with just two developers this conflict occurs so often.

I'd vote to lose a blame on a changelog for not continuously having to update PRs.

jromero avatar Oct 19 '18 14:10 jromero

In addition, it technically doesn't have to be yaml right? You can just piece out the changelog as one file per pr that gets parsed and merged (aka compiled). This way you can still keep the keep a changelog format.

Eg.

./changelog/pr-1.md

### Added
- Some feature

./changelog/pr-2.md

### Added
- Some other feature

### Fixed
- Some issue

Would result in:

### Added
- Some feature
- Some other feature

### Fixed
- Some issue

jromero avatar Oct 19 '18 14:10 jromero

Gitlab.com uses a simmilar approch: https://about.gitlab.com/2018/07/03/solving-gitlabs-changelog-conflict-crisis/

lioman avatar Oct 24 '18 07:10 lioman