Skip to content

Don't truncate the NuGet pre-release tag onto a trailing dot #331

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

Merged
matt-richardson merged 1 commit into from
Jul 31, 2026
Merged

Don't truncate the NuGet pre-release tag onto a trailing dot #331

Show file tree
Hide file tree
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
12 changes: 11 additions & 1 deletion source/OctoVersion.Core/OctoVersionInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,19 @@ public OctoVersionInfo(SemanticVersion semanticVersion) : base(
public string BuildMetadataWithPlus => string.IsNullOrWhiteSpace(BuildMetadata) ? string.Empty : $"+{InvalidBuildMetadataCharacters.Replace(BuildMetadata, "-")}";
public string FullSemVer => $"{MajorMinorPatch}{PreReleaseTagWithDash}";
public string InformationalVersion => $"{MajorMinorPatch}{PreReleaseTagWithDash}{BuildMetadataWithPlus}";
string NuGetCompatiblePreReleaseWithDash => PreReleaseTagWithDash.Substring(0, Math.Min(PreReleaseTagWithDash.Length, 20));
public string NuGetVersion => $"{MajorMinorPatch}{NuGetCompatiblePreReleaseWithDash}";

string NuGetCompatiblePreReleaseWithDash
{
get
{
var truncated = PreReleaseTagWithDash.Substring(0, Math.Min(PreReleaseTagWithDash.Length, 20));

//a trailing dot is an empty pre-release identifier, which is not a valid version
return truncated.TrimEnd('.');
}
}

public override string ToString()
{
return FullSemVer;
Expand Down
11 changes: 11 additions & 0 deletions source/OctoVersion.Tests/WhenStringifyingAnOctoVersionInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ public class WhenStringifyingAnOctoVersionInfo
"dependabot/npm_and_yarn/source/TentacleArmy.Web/ini-1.3.6",
"Branch.dependabot/npm_and_yarn/source/TentacleArmy.Web/ini-1.3.6.Sha.069392d9d2d37ddb6009998b92e70963badcc666");

//the NuGet-compatible pre-release is 20 characters, which lands this one exactly on a dot
static readonly OctoVersionInfo VersionWhereTheNuGetTruncationLandsOnADot = new(1,
1,
47,
"renovate-microsoft.aspnetcore.mvc.newtonsoftjson-10.x",
"Branch.renovate-microsoft.aspnetcore.mvc.newtonsoftjson-10.x.Sha.72529493c8ccfae2784cd604b7784294b03f388d");

//xunit is blurgh - IEnumerable of object[]? ick.
public static IEnumerable<object[]> PreReleaseTagWithDashTestCases()
{
Expand All @@ -54,6 +61,7 @@ public static IEnumerable<object[]> PreReleaseTagWithDashTestCases()
yield return new object[] { VersionWithPreReleaseTagAndBuildMetadata, "-pre", "it should append the pre-release tag, but not the build metadata" };
yield return new object[] { VersionWithLongPreReleaseTagAndBuildMetadata, "-mark-genericDocumentStore", "it should add the pre-release tag, and ignore the build metadata" };
yield return new object[] { VersionWithLongPreReleaseTagWithSlashesAndBuildMetadata, "-dependabot-npm-and-yarn-source-TentacleArmy.Web-ini-1.3.6", "it should add the pre-release tag, and ignore the build metadata" };
yield return new object[] { VersionWhereTheNuGetTruncationLandsOnADot, "-renovate-microsoft.aspnetcore.mvc.newtonsoftjson-10.x", "it should add the pre-release tag untruncated" };
}

[Theory]
Expand Down Expand Up @@ -108,6 +116,7 @@ public static IEnumerable<object[]> FullSemVerTestCases()
yield return new object[] { VersionWithPreReleaseTagAndBuildMetadata, "1.2.3-pre", "it should return the major.minor.patch and pre-release but not the build metadata" };
yield return new object[] { VersionWithLongPreReleaseTagAndBuildMetadata, "2021.1.3-mark-genericDocumentStore", "it should return the major.minor.patch and pre-release but not the build metadata" };
yield return new object[] { VersionWithLongPreReleaseTagWithSlashesAndBuildMetadata, "2021.1.3-dependabot-npm-and-yarn-source-TentacleArmy.Web-ini-1.3.6", "it should return the major.minor.patch and pre-release but not the build metadata" };
yield return new object[] { VersionWhereTheNuGetTruncationLandsOnADot, "1.1.47-renovate-microsoft.aspnetcore.mvc.newtonsoftjson-10.x", "it should return the major.minor.patch and the untruncated pre-release" };
}

[Theory]
Expand All @@ -126,6 +135,7 @@ public static IEnumerable<object[]> NuGetVersionTestCases()
yield return new object[] { VersionWithPreReleaseTagAndBuildMetadata, "1.2.3-pre", "it should return the major.minor.patch and pre-release but not the build metadata" };
yield return new object[] { VersionWithLongPreReleaseTagAndBuildMetadata, "2021.1.3-mark-genericDocumen", "it should return the major.minor.patch and trim the pre-release to 20 chars" };
yield return new object[] { VersionWithLongPreReleaseTagWithSlashesAndBuildMetadata, "2021.1.3-dependabot-npm-and-", "it should return the major.minor.patch and trim the pre-release to 20 chars" };
yield return new object[] { VersionWhereTheNuGetTruncationLandsOnADot, "1.1.47-renovate-microsoft", "a trimmed pre-release must not end with a dot" };
}

[Theory]
Expand All @@ -144,6 +154,7 @@ public static IEnumerable<object[]> InformationalVersionTestCases()
yield return new object[] { VersionWithPreReleaseTagAndBuildMetadata, "1.2.3-pre+build", "it should return the major.minor.patch and pre-release and build metadata" };
yield return new object[] { VersionWithLongPreReleaseTagAndBuildMetadata, "2021.1.3-mark-genericDocumentStore+Branch.mark-genericDocumentStore.Sha.fb13016f3a21d7c2058fb74ab25f19e5311c6550", "it should return the major.minor.patch and pre-release and build metadata" };
yield return new object[] { VersionWithLongPreReleaseTagWithSlashesAndBuildMetadata, "2021.1.3-dependabot-npm-and-yarn-source-TentacleArmy.Web-ini-1.3.6+Branch.dependabot-npm-and-yarn-source-TentacleArmy.Web-ini-1.3.6.Sha.069392d9d2d37ddb6009998b92e70963badcc666", "it should return the major.minor.patch and pre-release and build metadata" };
yield return new object[] { VersionWhereTheNuGetTruncationLandsOnADot, "1.1.47-renovate-microsoft.aspnetcore.mvc.newtonsoftjson-10.x+Branch.renovate-microsoft.aspnetcore.mvc.newtonsoftjson-10.x.Sha.72529493c8ccfae2784cd604b7784294b03f388d", "it should return the major.minor.patch and pre-release and build metadata" };
}

[Theory]
Expand Down
Loading