GothenburgBitFactory / bugwarrior

Pull github, bitbucket, and trac issues into taskwarrior
http://pypi.python.org/pypi/bugwarrior
GNU General Public License v3.0
736 stars 209 forks source link

Changelog #792

Closed ryneeverett closed 2 years ago

ryneeverett commented 3 years ago

We pushed 1.8.0 without a changelog to get it out the door.

Perhaps this could be automated with something like: https://github.com/github-changelog-generator/github-changelog-generator

ryneeverett commented 3 years ago

In case this doesn't get done, I'm at least going to try to keep track of major changes for release notes here, though I'll likely forget.

Major Changes

New and Removed Services

Notable Changes

ryneeverett commented 2 years ago

After updating the above comment for a while, I don't love this process but find that I can't think of a better workflow for this project.

I find a curated changelog like this useful where a git generated one is in my opinion useless.

But I've always found it a pain to update a changelog in the git work tree -- it either involves pushing commits just to update the changelog (and then there's the PR noise versus direct push dilemma) or pestering contributors to update the changelog themselves (and how do you maintain consistency with lots of people editing such a document?).

At the same time, I don't see any way to consistently remember to update an out-of-tree changelog like this.

I'm open to suggestions.

ryneeverett commented 2 years ago

Resolved by #957. Maintaining a draft pull request is the best compromise I've thought of so far.