pawamoy / git-changelog

Automatic Changelog generator using Jinja2 templates.

Home Page:https://pawamoy.github.io/git-changelog

Repository from Github https://github.compawamoy/git-changelogRepository from Github https://github.compawamoy/git-changelog

Modify changelog in-place

pawamoy opened this issue · comments

Related to the limitation issue #3, it would allow the user to incrementally update the changelog file:

  1. user generate the changelog for the first time OR user already has a changelog
  2. user generate the contents for the latest version only, and keep the previously formatted version intact

It would require some markers, but maybe we can use the already existing <a> tags. It should be done in the most flexible way for the user. The user should be able to do whatever he/she wants with the use of templates only! (and context injection). No extra/opinionated command-line options or markers... Also remember that the generated contents can be in any format, not only markdown!

Well, I ended up adding three CLI options for this:

  • --in-place (bool)
  • --version-regex: to find versions in an existing changelog file (markup agnostic)
  • --marker-line: to know where to inject/replace contents (markup agnostic)

So I believe I achieved what was described above. Closing.