Bug: Branch contains / is not replaced by - in build metadata

[melcloud]

GitVersion version: 4.0, 3.6.4
Problem:
Given a branch name contains /, e.g. hotfixes/build-script, the build metadata does not convert it to hyphen. This is not a valid semver 2.

{
  "Major":0,
  "Minor":2,
  "Patch":1,
  "PreReleaseTag":"beta.1",
  "PreReleaseTagWithDash":"-beta.1",
  "PreReleaseLabel":"beta",
  "PreReleaseNumber":1,
  "BuildMetaData":11,
  "BuildMetaDataPadded":"0011",
  "FullBuildMetaData":"11.Branch.hotfixes/build-script.Sha.301ff2de375da97133ab544c9561cbd909039877",
  "MajorMinorPatch":"0.2.1",
  "SemVer":"0.2.1-beta.1",
  "LegacySemVer":"0.2.1-beta1",
  "LegacySemVerPadded":"0.2.1-beta0001",
  "AssemblySemVer":"0.2.1.1",
  "FullSemVer":"0.2.1-beta.1+11",
  "InformationalVersion":"0.2.1-beta.1+11.Branch.hotfixes/build-script.Sha.301ff2de375da97133ab544c9561cbd909039877",
  "BranchName":"hotfixes/build-script",
  "Sha":"301ff2de375da97133ab544c9561cbd909039877",
  "NuGetVersionV2":"0.2.1-beta0001",
  "NuGetVersion":"0.2.1-beta0001",
  "CommitsSinceVersionSource":11,
  "CommitsSinceVersionSourcePadded":"0011",
  "CommitDate":"2018-10-31"
}

[Skoucail]

Any update on this?

NuGet 4.3.0 (and higher with support for SemVer 2.0) actually has issues with this.
Nuget pack defaults to version 1.0.0 when AssemblyInformationalVersion metadata contains forward slash
Nuget pack with invalid AssemblyInformationalVersion value reports "description is required"

And according to the Semantic Versioning 2.0.0 spec '/' isn't an allowed character.

Build metadata MAY be denoted by appending a plus sign and a series of dot separated identifiers immediately following the patch or pre-release version. Identifiers MUST comprise only ASCII alphanumerics and hyphen [0-9A-Za-z-]. Identifiers MUST NOT be empty. Build metadata SHOULD be ignored when determining version precedence. Thus two versions that differ only in the build metadata, have the same precedence. Examples: 1.0.0-alpha+001, 1.0.0+20130313144700, 1.0.0-beta+exp.sha.5114f85.

[Skoucail]

@arturcic i'm not sure if you are the correct person to tag into this. But for the moment you seem to be the most active in this repo.
Are you able to take a look at this? This is kinda a breaking issue if we want to use full SemVer2.0 with NuGet (or other tools) that implement the specification.

[asbjornu]

Fixed by #1704.

[andrewescutia]

this still seems to be an issue if you overwrite the assembly-informational-format. Take the following format defined in the yml: {MajorMinorPatch}{PreReleaseTagWithDash}+{BranchName}.{ShortSha}

I get the following: "InformationalVersion":"4.5.1-beta.2+feature/git-version-2.41f34da",

[Skoucail]

The fix was included in version 5.0.0. This version has only been released 14d ago.
Are you sure you tested the issue with a pre-release version of v5.0.0 and not with v4.x.x?

[KiLLeRRaT]

I'm still getting this issue as mentioned by @andrewescutia.

I'm running GitVersion version 5.1.2 through MSBuild.

I have the following in my GitVersion.yml:

assembly-informational-format: '{Major}.{Minor}.{Patch}+{CommitsSinceVersionSource}.Branch.{BranchName}.Sha.{ShortSha}'

The output is:

19.12.26+1.Branch.albert/test1.Sha.f5a0018

What I'm really trying to achieve is to have the exact same assembly-informational-format as the default one, but with a short Sha because the long Sha is giving path length trouble for me....

[asbjornu]

Can you see anything wrong with the regex FormatMetaDataPart?

GitVersion/src/GitVersionCore/SemanticVersioning/SemanticVersionBuildMetaData.cs

Lines 163 to 168 in 5d6ed2a

	private string FormatMetaDataPart(string value)
	{
	if(!string.IsNullOrEmpty(value))
	value = Regex.Replace(value, "[^0-9A-Za-z-.]", "-");
	return value;
	}

[Skoucail]

The think confusion is between the SemanticVersion and the other variables (in this case InformationalVersion).
The SemanticVersion spec doesn't allow certain characters. So that got fixed.
The other fields in the GitVersion output stayed untouched.

At first glance i don't believe there is a configuration option to change the SemanticVerion format.

[KiLLeRRaT]

I have created this PR that resolves the issue for the BranchName variable: #2008

This seems to do exactly what I need.

[Skoucail]

@KiLLeRRaT
I commented on the pull request. I don’t think the change is a good approach of the problem.

If i understand it correctly the problem is that you use the informational assembly version as SemVer because you need a shorter version of the default SemVer outputted by GitVersion.

The correct extension would be to add a configuration setting so the SemVersion format can be changed. And in the SemVer special chars aren’t allowed and get replaces by dashes.

[KiLLeRRaT]

Can you see anything wrong with the regex FormatMetaDataPart?

GitVersion/src/GitVersionCore/SemanticVersioning/SemanticVersionBuildMetaData.cs

Lines 163 to 168 in 5d6ed2a

	private string FormatMetaDataPart(string value)
	{
	if(!string.IsNullOrEmpty(value))
	value = Regex.Replace(value, "[^0-9A-Za-z-.]", "-");
	return value;
	}

@asbjornu I don't see anything wrong with the RegEx.

I don't think this method is called for the BranchName variable though.

If you look at

GitVersion/src/GitVersionCore/SemanticVersioning/SemanticVersionFormatValues.cs

Line 54 in 5d6ed2a

public string BranchName => semver.BuildMetaData.Branch;

you will see that it doens't to a .ToString("xxxxxx") on it. It just grabs the value.

The only place the code referenced by @asbjornu is called in from within this ToString method.