Changelog

[ryneeverett]

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]

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

• Top-level bugwarrior command (Top-level bugwarrior command. #882)
• Enhanced configuration validation. (Pydantic #849)
• Survive service failue. (Don't terminate all services on failure. (attempt 2) #825)

New and Removed Services

• Added Kanboard service. (Add support for Kanboard service (fixes: #223) #794)
• Added Azure Devops service. (Add Azure Devops Service (with tests) #808)
• Added Git-Bug service. (Add Git-Bug Service #934)
• Removed Megaplan service. (Drop Megaplan Service #844)

Notable Changes

• gitlab: Merge requests and todo's will respect default_priority setting rather than being set to 'H'. (Gitlab individual priorities #816)
• gitlab: Added distinct default priorities for issues, merge requests, and todo's. (Gitlab individual priorities #816)
• gitlab: Query support. (Allow custom query strings for gitlab config #876)
• gitlab: Exclude archived projects by default. (gitlab: exclude archived projects by default. #938)
• gitlab,bitbucket: Deprecate filter_merge_requests in favor of inverse include_merge_requests.(filter_merge_requests -> ! include_merge_requests #881)
• bitbucket: Remove basic auth and update oauth2 workflow. (bitbucket: update oauth2 workflow #888)
• jira: Personal Access Token (PAT) authentication support. (Support Jira Personal Access Tokens (PATs) #853)
• redmine: Query support. (Redmine query parameters #886)
• github: Pull issues by URL. (github: pull issues by url. Resolve #516. #898)
• notifications: Add applescript backend. (feat: macOS applescript notifications #948)

[ryneeverett]

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]

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