Skip to content

Commit bc6f7bf

Browse files
committed
Change breaking change documentation
1 parent 7766333 commit bc6f7bf

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

BREAKING_CHANGES.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,12 @@
5656
* The initialization wizard has been removed.
5757
* On the `develop`, `release` and `hotfix` branch the introduced branch related property `prevent-increment.when-current-commit-tagged` has been set to `false` to get the incremented instead of the tagged semantic version.
5858
* When setting the "ignore commits before" parameter to a future value, an exception will occur if no commits are found on the current branch. This behavior mimics that of an empty repository.
59-
* In the Git Flow workflows e.g. release/next yields to a patch version. If you have a tag 1.0.0 on main and branch from main to release/1.0.1 branch then the next version number will be 1.1.0. Because in the Git Flow workflow you have an addition IsRelease branch configuration with name hotfix this is expected. If you want the 1.0.1 as a next version you need to branch to hotfix/1.0.1 or hotfix/next and not release. In GitHub Flow workflow it is not a problem because there the increment is set to patch for release branch.
59+
* On the `GitFlow` workflow the increment property has been changed:
60+
* in branch `release` from `None` to `Minor` and
61+
* in branch `hotfix` from `None` to `Patch`
62+
* On the `GitHubFlow` workflow the increment property has been changed in branch `release` from `None` to `Patch`.
63+
* When creating a branch with name `hotfix/next` (by using the `GitFlow` workflow) or `release/next` (by the `GitHubFlow` workflow) the resulting version will yield to a patched version per default.
64+
* If you have a tag `1.0.0` on `main` and branch from `main` to `release/1.0.1` then the next version number will be `1.1.0` when using the `GitFlow` workflow. This behavior is expected (but different compared to the `GitHubFlow` workflow) because on the `GitFlow` workflow you have an addition branch configuration with name hotfix where `is-release-branch` is set to `true`. That means if you want `1.0.1` as a next version you need to branch to `hotfix/1.0.1` or `hotfix/next`. On the other hand if you use the `GitHubFlow` workflow the next version number will be `1.0.1` because the increment on the `release` branch is set to `Patch`.
6065
6166
## v5.0.0
6267

0 commit comments

Comments
 (0)