Use individual files for changelog entries

[dominiklohmann]

📔 Description

This helps avoid merge conflicts in the CHANGELOG.md file by generating it.

📝 Checklist

• All user-facing changes have changelog entries.
• The changes are reflected on docs.tenzir.com/vast, if necessary.
• The PR description contains instructions for the reviewer, if necessary.

🎯 Review Instructions

Commit-by-commit.

[mavam]

Is this adding a separate commit to master with every merge?

[dominiklohmann]

Is this adding a separate commit to master with every merge?

For every merge that adds a changelog entry, yes. The alternative would be not to have a readable changelog file in the repository that we can link to. That we do regularly, hence the workflow.

[mavam]

How about we just update the changelog with every release? It wouldn't change the logic you have in place, but reduce commit churn by quite a bit.

Or an alternative: amend the merge commit.

[dominiklohmann]

How about we just update the changelog with every release? It wouldn't change the logic you have in place, but reduce commit churn by quite a bit.

I don't see the issue, really. It's one commit per merge immediately after merging a PR, which is less than one a day. It really doesn't add much noise.

We use a pinned VAST version internally that is not tied to our release cycle. If we update on every release only, we lose the ability to just click on the submodule and easily see the most recent changes.

Or an alternative: amend the merge commit.

Not an option. Let's not get into the business of force-pushing to our default branch.

[dominiklohmann]

Peer-reviewed with @tobim.