Introduce `CustomVersion` variable #4659

phatcher · 2025-08-16T09:11:48Z

Introduces a new output variable CustomVersion and an associated formatting variable custom-version-format

Description

Intent is to allow the user to define an output variable without changing the semantics of existing ones. This can then be used to resolve issues such as providing an appropriate version to tools such as NuGet which do not fully followed semantic versioning rules.

Related Issue

Motivation and Context

See above

How Has This Been Tested?

Additional tests in ConfigurationProviderTest for custom-version-format and updated test outputs elsewhere to align

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.

Copilot

Pull Request Overview

This PR introduces a new CustomVersion output variable and associated custom-version-format configuration option to provide users with a customizable version string that doesn't affect existing semantics. This addresses compatibility issues with tools like NuGet that don't fully follow semantic versioning rules.

Key changes:

Added CustomVersion property to GitVersionVariables with configurable formatting
Introduced custom-version-format configuration option with default value {SemVer}
Updated test outputs and documentation to include the new variable

Reviewed Changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/GitVersion.Core/OutputVariables/GitVersionVariables.cs	Added CustomVersion property to the record and included it in property collections
src/GitVersion.Core/Configuration/IGitVersionConfiguration.cs	Added CustomVersionFormat property to configuration interface
src/GitVersion.Configuration/GitVersionConfiguration.cs	Implemented CustomVersionFormat configuration property with JSON serialization attributes
src/GitVersion.Core/VersionCalculation/VariableProvider.cs	Added logic to format and provide CustomVersion variable
docs/input/docs/reference/variables.md	Updated documentation to include CustomVersion variable description
schemas/6.4/GitVersion.configuration.json	Added custom-version-format to configuration schema
Various test files	Updated approved test outputs to include CustomVersion in generated code

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

schemas/6.4/GitVersion.json

schemas/6.4/GitVersion.configuration.json

docs/input/docs/usage/cli/arguments.md

phatcher · 2025-08-16T09:25:42Z

@arturcic Why did you revert the doc change on my branch?

Also, confused as to why some of the App tests are failing e.g. WixVersionFileContentTest doesn't have the CustomVersion output, but the module tests pass.

Is there another mechanism other than GitVersionVariables that I need to update?

phatcher · 2025-08-16T09:31:20Z

One other question is whether the changes should be under the 6.4 schema or be bumped to a 6.5 schema?

arturcic · 2025-08-16T09:54:04Z

One other question is whether the changes should be under the 6.4 schema or be bumped to a 6.5 schema?

The schema is updated as part of the release

arturcic · 2025-08-16T09:55:26Z

@arturcic Why did you revert the doc change on my branch?

Also, confused as to why some of the App tests are failing e.g. WixVersionFileContentTest doesn't have the CustomVersion output, but the module tests pass.

Is there another mechanism other than GitVersionVariables that I need to update?

That's not me who updated, but of you want to change the configuration.md you need to update mdsource instead

phatcher · 2025-09-17T10:13:04Z

Can we approve this now or is there something else to do?

asbjornu

I think this looks good in terms of the code. But the commits are a bit messy. Could you please clean them up a bit? There's also an issue with the coverlet step failing on the windows-2025 runner.

Calculating coverage result...
C:\Users\runneradmin\.nuget\packages\coverlet.msbuild\6.0.4\build\coverlet.msbuild.targets(72,5): error : Unable to read beyond the end of the stream. [D:\a\GitVersion\GitVersion\src\GitVersion.App.Tests\GitVersion.App.Tests.csproj::TargetFramework=net8.0]
C:\Users\runneradmin\.nuget\packages\coverlet.msbuild\6.0.4\build\coverlet.msbuild.targets(72,5): error :    at System.IO.BinaryReader.ReadInt32() [D:\a\GitVersion\GitVersion\src\GitVersion.App.Tests\GitVersion.App.Tests.csproj::TargetFramework=net8.0]
C:\Users\runneradmin\.nuget\packages\coverlet.msbuild\6.0.4\build\coverlet.msbuild.targets(72,5): error :    at Coverlet.Core.Coverage.CalculateCoverage() in /_/src/coverlet.core/Coverage.cs:line 420 [D:\a\GitVersion\GitVersion\src\GitVersion.App.Tests\GitVersion.App.Tests.csproj::TargetFramework=net8.0]
C:\Users\runneradmin\.nuget\packages\coverlet.msbuild\6.0.4\build\coverlet.msbuild.targets(72,5): error :    at Coverlet.Core.Coverage.GetCoverageResult() in /_/src/coverlet.core/Coverage.cs:line 160 [D:\a\GitVersion\GitVersion\src\GitVersion.App.Tests\GitVersion.App.Tests.csproj::TargetFramework=net8.0]
C:\Users\runneradmin\.nuget\packages\coverlet.msbuild\6.0.4\build\coverlet.msbuild.targets(72,5): error :    at Coverlet.MSbuild.Tasks.CoverageResultTask.Execute() in /_/src/coverlet.msbuild.tasks/CoverageResultTask.cs:line 87 [D:\a\GitVersion\GitVersion\src\GitVersion.App.Tests\GitVersion.App.Tests.csproj::TargetFramework=net8.0]

Ideas @arturcic?

asbjornu · 2025-09-17T11:11:31Z

src/GitVersion.Configuration.Tests/Configuration/ConfigurationProviderTests.cs

+        using var _ = this.fileSystem.SetupConfigFile(path: this.repoPath, text: text);
+        var configuration = this.configurationProvider.ProvideForDirectory(this.repoPath);
+
+        configuration.CustomVersionFormat.ShouldBe("custom-version-format-from-yml");


Should we have tests for non-constant strings as well?

phatcher · 2025-09-18T11:39:52Z

Can I just do a squash commit/rebase to tidy the commits up - surely you do a squash on merge anyway?

asbjornu · 2025-09-18T11:44:07Z

Can I just do a squash commit/rebase to tidy the commits up - surely you do a squash on merge anyway?

No, we don't do squash merge commits. We like to keep the commit history and merge commits, but in this case it's a bit messy. If you want to rebase and squash everything into one commit, that's fine by me. 👍🏼

phatcher · 2025-09-18T11:47:56Z

Also, not sure how to address the flaky windows/qodana builds

asbjornu · 2025-09-18T12:01:56Z

Also, not sure how to address the flaky windows/qodana builds

No, it seems unrelated to this PR. I'm hoping @arturcic has an idea.

arturcic · 2025-09-18T15:34:53Z

Also, not sure how to address the flaky windows/qodana builds

No, it seems unrelated to this PR. I'm hoping @arturcic has an idea.

I noticed that as well, not much we can do at this point. We can re-run the failed jobs for the windows and that will succeed the second time, qodana usually fails whenever the global.json sdk is updated, it takes time for their action to update for the latest sdk

sonarqubecloud · 2025-09-21T08:01:25Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.3% Duplication on New Code

See analysis details on SonarQube Cloud

phatcher · 2025-09-21T08:34:44Z

@asbjornu I've squashed the commits, is there anything else I need to do?

asbjornu

Just one last question, otherwise this looks good to me!

asbjornu · 2025-09-21T15:39:03Z

docs/input/docs/usage/cli/arguments.md


 Following options are supported:

-1. `assembly-file-versioning-format`


Why is assembly-file-versioning-format removed?

phatcher · 2025-09-21T16:13:22Z

Bad merge - I’ll add it backSent from my iPhoneOn 21 Sep 2025, at 16:41, Asbjørn Ulsberg ***@***.***> wrote: @asbjornu approved this pull request. Just one last question, otherwise this looks good to me! In docs/input/docs/usage/cli/arguments.md:

@@ -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` Why is assembly-file-versioning-format removed? —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you authored the thread.Message ID: ***@***.***>

Copilot AI review requested due to automatic review settings August 16, 2025 09:11

Copilot AI reviewed Aug 16, 2025

View reviewed changes

asbjornu force-pushed the feature/customversion branch from ade0456 to 31323e6 Compare September 12, 2025 08:26

asbjornu requested changes Sep 17, 2025

View reviewed changes

Introduce CustomVersion and custom-version-format

49ff7a3

phatcher force-pushed the feature/customversion branch from 390eb01 to 49ff7a3 Compare September 21, 2025 07:58

asbjornu approved these changes Sep 21, 2025

View reviewed changes


		Following options are supported:

		1. `assembly-file-versioning-format`

Introduce CustomVersion variable #4659

Are you sure you want to change the base?

Introduce CustomVersion variable #4659

Conversation

phatcher commented Aug 16, 2025

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Checklist:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

phatcher commented Aug 16, 2025

Uh oh!

phatcher commented Aug 16, 2025

Uh oh!

arturcic commented Aug 16, 2025

Uh oh!

arturcic commented Aug 16, 2025

Uh oh!

phatcher commented Sep 17, 2025

Uh oh!

asbjornu left a comment

Choose a reason for hiding this comment

Uh oh!

asbjornu Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

phatcher commented Sep 18, 2025

Uh oh!

asbjornu commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

phatcher commented Sep 18, 2025

Uh oh!

asbjornu commented Sep 18, 2025

Uh oh!

arturcic commented Sep 18, 2025

Uh oh!

sonarqubecloud bot commented Sep 21, 2025

Quality Gate passed

Uh oh!

phatcher commented Sep 21, 2025

Uh oh!

asbjornu left a comment

Choose a reason for hiding this comment

Uh oh!

asbjornu Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

phatcher commented Sep 21, 2025 via email

Uh oh!

Uh oh!

Introduce `CustomVersion` variable #4659

Introduce `CustomVersion` variable #4659

asbjornu commented Sep 18, 2025 •

edited

Loading