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.

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

Honor AssemblyVersion as explicitly set in version.json #707

Merged
merged 1 commit into from
Dec 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 12 additions & 6 deletions src/NerdBank.GitVersioning.Tests/BuildIntegrationTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1009,13 +1009,19 @@ private static Version GetExpectedAssemblyVersion(VersionOptions versionOptions,
{
// Function should be very similar to VersionOracle.GetAssemblyVersion()
var assemblyVersion = (versionOptions?.AssemblyVersion?.Version ?? versionOptions.Version.Version).EnsureNonNegativeComponents();
var precision = versionOptions?.AssemblyVersion?.Precision ?? VersionOptions.DefaultVersionPrecision;

assemblyVersion = new System.Version(
assemblyVersion.Major,
precision >= VersionOptions.VersionPrecision.Minor ? assemblyVersion.Minor : 0,
precision >= VersionOptions.VersionPrecision.Build ? version.Build : 0,
precision >= VersionOptions.VersionPrecision.Revision ? version.Revision : 0);
if (versionOptions?.AssemblyVersion?.Version is null)
{
VersionOptions.VersionPrecision precision = versionOptions?.AssemblyVersion?.Precision ?? VersionOptions.DefaultVersionPrecision;
assemblyVersion = version;

assemblyVersion = new Version(
assemblyVersion.Major,
precision >= VersionOptions.VersionPrecision.Minor ? assemblyVersion.Minor : 0,
precision >= VersionOptions.VersionPrecision.Build ? assemblyVersion.Build : 0,
precision >= VersionOptions.VersionPrecision.Revision ? assemblyVersion.Revision : 0);
}

return assemblyVersion;
}

Expand Down
26 changes: 26 additions & 0 deletions src/NerdBank.GitVersioning.Tests/VersionOracleTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,32 @@ public void SemVerStableNonPublicVersionShortened()
Assert.Matches(@"^2.3.1-g[a-f0-9]{7}$", oracle.ChocolateyPackageVersion);
}

[Theory]
[InlineData("1.2.0.0", null, null)]
[InlineData("1.0.0.0", null, VersionOptions.VersionPrecision.Major)]
[InlineData("1.2.0.0", null, VersionOptions.VersionPrecision.Minor)]
[InlineData("1.2.1.0", null, VersionOptions.VersionPrecision.Build)]
[InlineData("2.3.4.0", "2.3.4", null)]
[InlineData("2.3.4.0", "2.3.4", VersionOptions.VersionPrecision.Minor)]
[InlineData("2.3.4.0", "2.3.4", VersionOptions.VersionPrecision.Build)]
[InlineData("2.3.4.0", "2.3.4.0", VersionOptions.VersionPrecision.Revision)]
public void CustomAssemblyVersion(string expectedAssemblyVersion, string prescribedAssemblyVersion, VersionOptions.VersionPrecision? precision)
{
this.InitializeSourceControl(withInitialCommit: false);
this.WriteVersionFile(new VersionOptions
{
Version = new SemanticVersion("1.2"),
AssemblyVersion = new VersionOptions.AssemblyVersionOptions
{
Version = prescribedAssemblyVersion is object ? new Version(prescribedAssemblyVersion) : null,
Precision = precision,
},
});

VersionOracle oracle = this.GetVersionOracle();
Assert.Equal(expectedAssemblyVersion, oracle.AssemblyVersion.ToString());
}

[Fact]
public void DefaultNuGetPackageVersionIsSemVer1PublicRelease()
{
Expand Down
27 changes: 19 additions & 8 deletions src/NerdBank.GitVersioning/VersionOracle.cs
Original file line number Diff line number Diff line change
Expand Up @@ -444,14 +444,25 @@ private static Version GetAssemblyVersion(Version version, VersionOptions? versi
// If there is no repo, "version" could have uninitialized components (-1).
version = version.EnsureNonNegativeComponents();

var assemblyVersion = versionOptions?.AssemblyVersionOrDefault.Version ?? new System.Version(version.Major, version.Minor);
var precision = versionOptions?.AssemblyVersionOrDefault.PrecisionOrDefault;

assemblyVersion = new System.Version(
assemblyVersion.Major,
precision >= VersionOptions.VersionPrecision.Minor ? assemblyVersion.Minor : 0,
precision >= VersionOptions.VersionPrecision.Build ? version.Build : 0,
precision >= VersionOptions.VersionPrecision.Revision ? version.Revision : 0);
Version assemblyVersion;

if (versionOptions?.AssemblyVersion?.Version is not null)
{
// When specified explicitly, use the assembly version as the user defines it.
assemblyVersion = versionOptions.AssemblyVersion.Version;
}
else
{
// Otherwise consider precision to base the assembly version off of the main computed version.
VersionOptions.VersionPrecision precision = versionOptions?.AssemblyVersion?.Precision ?? VersionOptions.DefaultVersionPrecision;

assemblyVersion = new Version(
version.Major,
precision >= VersionOptions.VersionPrecision.Minor ? version.Minor : 0,
precision >= VersionOptions.VersionPrecision.Build ? version.Build : 0,
precision >= VersionOptions.VersionPrecision.Revision ? version.Revision : 0);
}

return assemblyVersion.EnsureNonNegativeComponents(4);
}

Expand Down
9 changes: 8 additions & 1 deletion src/NerdBank.GitVersioning/version.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,15 @@
{ "$ref": "#/definitions/twoToFourComponentVersion" },
{
"type": "object",
"additionalProperties": false,
"properties": {
"version": { "$ref": "#/definitions/twoToFourComponentVersion" }
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"version": { "$ref": "#/definitions/twoToFourComponentVersion" },
"precision": {
"type": "string",
"description": "Identifies the last component to be explicitly set in the version.",
Expand Down