qutebrowser icon indicating copy to clipboard operation
qutebrowser copied to clipboard

Adopt a changelog management tool / news fragments

Open The-Compiler opened this issue 3 years ago • 5 comments

We should adopt something like Scriv or Towncrier so that contributors can write their own changelog files instead of having to manually write a changelog when merging PRs.

This would hopefully also allow us to add authors and issue/PR numbers to changelog entries easily.

The-Compiler avatar Apr 03 '22 16:04 The-Compiler

Another possibility would be GitHub's Automatically generated release notes (plus me also using pull-requests for everything I do).

However, I don't think it's a good fit for a project of the size/complexity of qutebrowser - I think there's a lot of value in being able to hand-write changelog entries and curate them easily.

The-Compiler avatar Jul 11 '23 10:07 The-Compiler

Just to clarify; My 👍 refers to that part:

However, I don't think it's a good fit for a project of the size/complexity of qutebrowser - I think there's a lot of value in being able to hand-write changelog entries and curate them easily.

mschilli87 avatar Jul 11 '23 11:07 mschilli87

I don't know if you are looking for such a tool, but you can check out https://logchange.dev/tools/logchange/getting-started/

Jinja templates should meet your needs.

Apache Solr using it exactly because of wasting time for pull requests conflicts

https://lists.apache.org/thread/4dotf4qx4ss3qr3xonv2y63v7wdg40nt

marwin1991 avatar Nov 01 '25 08:11 marwin1991

Thanks for the recommendation, but I'll go with either Towncrier or Scriv over what seems like a somewhat overengineered Java project. Not only for personal preference, also because a Python tool integrates into a Python project with way less friction.

The-Compiler avatar Nov 01 '25 11:11 The-Compiler