Skip to content

Introduce CustomVersion variable #4659

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

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Introduce CustomVersion variable #4659

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
a162094
Introduce CustomVersion and custom-version-format
Aug 16, 2025
2abc6c3
Docs changes
arturcic Aug 16, 2025
7e9fdae
Update schema version
Aug 16, 2025
edab357
Update docs/input/docs/usage/cli/arguments.md
phatcher Aug 25, 2025
1da8e82
Align VersionVariablesJsonModel to git version variables
phatcher Aug 25, 2025
03a0238
Merge branch 'feature/customversion' of https://github.com/phatcher/G…
phatcher Aug 25, 2025
63bd063
Docs changes
arturcic Aug 25, 2025
4c6caee
Standardize docs
phatcher Aug 25, 2025
c8cdd2f
Merge branch 'feature/customversion' of https://github.com/phatcher/G…
phatcher Aug 25, 2025
68ad8da
Correct documentation
phatcher Aug 25, 2025
ade0456
Docs changes
arturcic Aug 25, 2025
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
6 changes: 6 additions & 0 deletions docs/input/docs/reference/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,6 +519,12 @@ Specifies the format of `AssemblyInformationalVersion`.
Follows the same formatting semantics as `assembly-file-versioning-format`.
The default value is `{InformationalVersion}`.

### custom-version-format

Specifies the format of `CustomVersion`.
Follows the same formatting semantics as `assembly-file-versioning-format`.
The default value is `{SemVer}`.

### mode

Sets the `mode` of how GitVersion should create a new version. Read more at
Expand Down
6 changes: 6 additions & 0 deletions docs/input/docs/reference/mdsource/configuration.source.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,12 @@ Specifies the format of `AssemblyInformationalVersion`.
Follows the same formatting semantics as `assembly-file-versioning-format`.
The default value is `{InformationalVersion}`.

### custom-version-format

Specifies the format of `CustomVersion`.
Follows the same formatting semantics as `assembly-file-versioning-format`.
The default value is `{SemVer}`.

### mode

Sets the `mode` of how GitVersion should create a new version. Read more at
Expand Down
2 changes: 2 additions & 0 deletions docs/input/docs/reference/variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ what is available. For the `release/3.0.0` branch of GitVersion it shows:
"AssemblySemVer": "3.22.11.0",
"AssemblySemFileVer": "3.22.11.0",
"InformationalVersion": "3.22.11-beta.99+88.Branch.release/3.022.011.Sha.28c853159a46b5a87e6cc9c4f6e940c59d6bc68a",
"CustomVersion": "3.22.11-beta.99",
"FullSemVer": "3.22.11-beta.99+88",
"BranchName": "release/3.022.011",
"EscapedBranchName": "release-3.022.011",
Expand Down Expand Up @@ -59,6 +60,7 @@ Each property of the above JSON document is described in the below table.
| `AssemblySemVer` | Suitable for .NET `AssemblyVersion`. Defaults to `Major.Minor.0.0` to allow the assembly to be hotfixed without breaking existing applications that may be referencing it. |
| `AssemblySemFileVer` | Suitable for .NET `AssemblyFileVersion`. Defaults to `Major.Minor.Patch.0`. |
| `InformationalVersion` | Suitable for .NET `AssemblyInformationalVersion`. Defaults to `FullSemVer` suffixed by `FullBuildMetaData`. |
| `CustomVersion` | The custom version, suitable for non-semantic package managers with formatting changes, e.g. NuGet. Defaults to `SemVer`. |
| `FullSemVer` | The full, SemVer 2.0 compliant version number. |
| `BranchName` | The name of the checked out Git branch. |
| `EscapedBranchName` | Equal to `BranchName`, but with `/` replaced with `-`. |
Expand Down
14 changes: 7 additions & 7 deletions docs/input/docs/usage/cli/arguments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,13 +113,13 @@ Double quote character inside of the double quoted `value` has to be be escaped

Following options are supported:

1. `assembly-file-versioning-format`
2. `assembly-file-versioning-scheme`
3. `assembly-informational-format`
4. `assembly-versioning-format`
5. `assembly-versioning-scheme`
6. `commit-date-format`
7. `commit-message-incrementing`
1. `assembly-file-versioning-scheme`
2. `assembly-informational-format`
3. `assembly-versioning-format`
4. `assembly-versioning-scheme`
5. `commit-date-format`
6. `commit-message-incrementing`
7. `custom-version-format`
8. `label`
9. `increment`
10. `major-version-bump-message`
Expand Down
Loading