Ignore reverted commits when generating changelogs

[bklp]

In case when there is commit + revert commit (with ref to the original commit) within a single version/tag, it would make sense to exclude both of them from commits passed for changelog rendering as they should basically cancel each other anyway. It would be nice to have it at least as an optional feature that can be enabled using configuration.

GitLab's changelog generator seems to have similar feature already, see:

• https://gitlab.com/gitlab-com/gl-infra/delivery/-/issues/1583
• https://gitlab.com/gitlab-org/gitlab/-/merge_requests/55537

[tomasbjerre]

See this test case:

git-changelog-lib/src/test/java/se/bjurr/gitchangelog/api/GitChangelogApiTest.java

Line 310 in d42e8fa

public void testThatRevertedCommitsAreRemoved() throws Exception {

Where git history is:

* 4c6e078 - doing change 2
* 05866f7 - Revert "doing change 1"
* 114a917 - doing change 1
* 5973dd5 - Updating changelog with 1.147.2 [GRADLE SCRIPT]
* aa1fd33 - (tag: 1.147.2) New version: 1.147.2 [GRADLE SCRIPT]

This template:
https://github.com/tomasbjerre/git-changelog-lib/blob/d42e8fa63405b1d152e47d39dd48643bde82b1f8/src/test/resources/templatetest/testThatRevertedCommitsAreRemoved.mustache

Gives this result:

git-changelog-lib/src/test/java/se/bjurr/gitchangelog/api/GitChangelogApiTest.testThatRevertedCommitsAreRemoved.approved.txt

Line 38 in d42e8fa

---------------------------------------------

Is this what you want?

[bklp]

Yes, that is what I meant. I'd just note following:

1. It should also work for case when multiple commits are reverted using single revert commit.
2. What happens when there is revert commit of other revert commit(s) is something to consider too.