Skip to content

Commit 04d77ec

Browse files
authored
Merge pull request #2963 from asbjornu/feature/next-version
Elaborate on `next-version`
2 parents debc84f + cfbe94b commit 04d77ec

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

docs/input/docs/reference/configuration.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,18 @@ The details of the available options are as follows:
6868
6969
### next-version
7070
71-
Allows you to bump the next version explicitly, useful for bumping `main` or a
72-
feature with breaking changes (i.e., a major increment).
71+
Allows you to bump the next version explicitly. Useful for bumping `main` or a
72+
feature branch with breaking changes (i.e., a major increment), indicating what
73+
the next `git tag` is going to be.
74+
75+
`next-version` is not a permanent replacement for `git tag` and should only be
76+
used intermittently. Since version 5.5 GitVersion supports `next-version` with
77+
`mode: Mainline` and should not be treated as a "base version".
78+
79+
If you are using `next-version` and are experiencing weird versioning behaviour,
80+
please remove it, create a `git tag` with an appropriate version number on an
81+
appropriate historical commit and see if that resolves any versioning issues
82+
you may have.
7383

7484
### assembly-versioning-scheme
7585

0 commit comments

Comments
 (0)