Skip to content

Commit 32e446b

Browse files
BinTossarturcic
authored andcommitted
docs: add note regarding semantic-release's arbitrary revert rule
If this is not respected in GitVersion's config... ...or if the revert rule is not overridden in semantic-release's config... ...then semantic-release may generate a different PATCH version than GitVersion.
1 parent e397c87 commit 32e446b

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/input/docs/reference/version-increments.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,10 @@ patch-version-bump-message: "^(fix|perf)(\\([\\w\\s-]*\\))?:"
103103
This will ensure that your version gets bumped according to the commits you've
104104
created.
105105

106+
If your CI/CD workflow uses semantic-release's commit-analyzer, change `(fix|perf)` to `(fix|perf|revert)`. [Why?](https://github.com/semantic-release/commit-analyzer/blob/75c9c87c88772d7ded4ca9614852b42519e41931/lib/default-release-rules.js#L8C1-L8C38)
107+
108+
Alternatively, you can override this rule in the [configuration](https://github.com/semantic-release/commit-analyzer/tree/master#usage) of \@semantic-release/commit-analyzer.
109+
106110
### GitVersion.yml
107111

108112
The first is by setting the `next-version` property in the GitVersion.yml file.

0 commit comments

Comments
 (0)