Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Elaborate on next-version #2963

Merged
merged 1 commit into from
Jan 18, 2022
Merged

Elaborate on next-version #2963

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions docs/input/docs/reference/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,18 @@ The details of the available options are as follows:

### next-version

Allows you to bump the next version explicitly, useful for bumping `main` or a
feature with breaking changes (i.e., a major increment).
Allows you to bump the next version explicitly. Useful for bumping `main` or a
feature branch with breaking changes (i.e., a major increment), indicating what
the next `git tag` is going to be.

`next-version` is not a permanent replacement for `git tag` and should only be
used intermittently. Since version 5.5 GitVersion supports `next-version` with
`mode: Mainline` and should not be treated as a "base version".

If you are using `next-version` and are experiencing weird versioning behaviour,
please remove it, create a `git tag` with an appropriate version number on an
appropriate historical commit and see if that resolves any versioning issues
you may have.

### assembly-versioning-scheme

Expand Down