Skip to content

Commit c894b3d

Browse files
committed
Added version bumping via commit messages to docs
1 parent 409f5e8 commit c894b3d

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/more-info/version-increments.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,23 @@ See [Octopus deploy](build-server-setup/octopus-deploy.md)
2222
## Manually incrementing the version
2323
With v3 there are multiple approaches.
2424

25+
### Commit messages
26+
Adding `+semver: breaking` or `+semver: major` will cause the major version to be increased, `+semver: feature` or `+semver:minor` will bump minor and `+semver:patch` or `+semver:fix` will bump the patch.
27+
28+
#### Configuration
29+
The feature is enabled by default but can be disabled via configuration, the regex we use can be changed:
30+
31+
```
32+
major-version-bump-message: '\+semver:\s?(breaking|major)'
33+
minor-version-bump-message: '\+semver:\s?(feature|minor)'
34+
patch-version-bump-message: '\+semver:\s?(fix|patch)'
35+
commit-message-incrementing: Enabled
36+
```
37+
38+
The options for `commit-message-incrementing` are `Enabled`, `MergeMessageOnly` and `Disabled`
39+
40+
If the incrementing mode is set to `MergeMessageOnly` you can add this information in when merging a pull request. This prevents commits within a PR bumping the version.
41+
2542
### GitVersionConfig.yaml
2643
The first is by setting the `next-version` property in the GitVersionConfig.yaml file. This property only serves as a base version,
2744

0 commit comments

Comments
 (0)