MSBuild Task for Semantic Versioning & Tests #137

JohnTortugo · 2018-04-26T20:58:26Z

Implementation of generation of Versioning Strings as described in the plan.

Support for SemVer. 2.0
Support for SemVer. 1.0
Store computed information on a file to prevent unecessary re-computation.
Migrate task for extracting date+revision from OfficialBuildId
Add basic testing for Targets and Tasks
Documentation with usage examples

Suggestions are welcome.

src/Microsoft.DotNet.Build.Tasks.SemVer/SemVer.cs

+
+namespace Microsoft.DotNet.Build.Tasks.SemVer
+{
+    public class SemVer : Task


src/Microsoft.DotNet.Build.Tasks.SemVer/SemVer.cs

+            }
+
+            // So far we know that these first four fields aren't empty
+            Version = $"{Major}.{Minor}.{Patch}-{Prerelease}.{ShortDate:00000}.{Builds}+{ShortSHA}";


src/Microsoft.DotNet.Build.Tasks.SemVer/SemVer.cs

+    {
+        private Dictionary<string, string> formats = new Dictionary<string, string> {
+                                    {"dev", "{major}.{minor}.{patch}-{prerelease}.{shortdate}.{builds}+{shortsha}"},
+                                    {"stable", "{major}.{minor}.{patch}-{prerelease}"},


src/Microsoft.DotNet.Build.Tasks.Versioning/Microsoft.DotNet.Build.Tasks.Versioning.csproj

+  <ItemGroup Condition="'$(TargetFramework)' == '$(NetFxTfm)'">
+    <Reference Include="Microsoft.Build.Tasks.v4.0" />
+    <Reference Include="Microsoft.Build.Framework" />
+    <Reference Include="Microsoft.Build.Utilities.v4.0" />


src/Microsoft.DotNet.Build.Tasks.Versioning/Versioning.cs

+            VersionString = VersionString.Replace("{builds}", Builds.ToString());
+            VersionString = VersionString.Replace("{shortsha}", ShortSHA);
+
+            return true;


src/Microsoft.DotNet.Build.Tasks.SemVer/SemVer.cs

+{
+    public class SemVer : Task
+    {
+        private Dictionary<string, string> formats = new Dictionary<string, string> {


src/Microsoft.DotNet.Build.Tasks.SemVer/SemVer.cs

+                VersionString = formats[VersionString];
+            }
+
+            if ((VersionString.Contains("{major}") && Major == 0) ||


src/Microsoft.DotNet.Build.Tasks.SemVer/SemVer.cs

+        {
+            VersionString = FormatString.ToLower();
+
+            if (formats.ContainsKey(VersionString))


mmitche

A few comments.

weshaggard · 2018-05-01T20:23:07Z

I'm still very much interested in why this is a task instead of just done in a targets file? All we are doing is appending strings.

JohnTortugo · 2018-05-01T22:39:01Z

Talked with @weshaggard and @mmitche ; I am going to work on the changes they suggested.

… need some kind of date manipulation eventually.

JohnTortugo · 2018-05-07T17:34:29Z

Hi guys, I've applied the changes. PTAL

src/Microsoft.DotNet.Build.Tasks.Versioning/README.md

+===============================
+
+Task package which handles generation of version strings. 
+The format that we use is described here: Documentation/Versioning.md


src/Microsoft.DotNet.Build.Tasks.Versioning/README.md

+ShortSha        | string      | SHA of the repo last commit.
+FormatName      | string      | The name of the format string you want to use. Defaults are "dev", "stable" and "final".
+FormatStrings   | ItemGroup   | Your custom format strings.
+ExitCode        | integer     | **Output** Indicate whether an error happened (1) or not (0).


src/Microsoft.DotNet.Build.Tasks.Versioning/Versioning.props

+    <PropertyGroup>
+      <VersionString Condition="'%(FormatStrings.Identity)'=='$(FormatName)'">%(FormatStrings.Format)</VersionString>
+
+      <ExitCode Condition="'$(VersionString)'!=''">0</ExitCode>


src/Microsoft.DotNet.Build.Tasks.Versioning/src/GenerateVersioningDate.cs

+            if (months > 0) //only allow dates after comparedate
+            {
+                return string.Format("{0}{1}", months.ToString("D" + (Padding - 2)), seedDate.Day.ToString("D2"));
+            }


src/Microsoft.DotNet.Build.Tasks.Versioning/Versioning.props

+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+
+  <Target Name="Versioning">
+


weshaggard · 2018-05-14T17:52:41Z

I think the option of creating a few TestCase01.xml, TestCase02.xml, etc files and them calling "dotnet msbuild" is interesting, because: 1) it's simple; 2) we have quite some control of the test and the output; 3) Is quite portable across .net core and .net full?! 4) Do we need something more sophisticated?

Are those TestCase01.xml files csproj's? If so then that is similar to what I had in mind. Having some sample test projects that we call msbuild on and capture the output of the version in some way, or asserting it in the projects themselves by having them fail to build if the versions don't match what is expected.

…few places.

JohnTortugo · 2018-05-14T20:44:18Z

Are those TestCase01.xml files csproj's? If so then that is similar to what I had in mind. Having some sample test projects that we call msbuild on and capture the output of the version in some way, or asserting it in the projects themselves by having them fail to build if the versions don't match what is expected.

Yes, that's exactly it.

weshaggard · 2018-05-14T21:22:03Z

@joperezr given your experience doing this in Buildtools could you also review this PR?

joperezr · 2018-05-14T21:31:59Z

Sure, I’ll take a look at this later today

src/Microsoft.DotNet.Build.Tasks.Versioning/README.md

@@ -0,0 +1,134 @@
+# Microsoft.DotNet.Build.Tasks.Versioning
+
+Task package which handles generation of version strings. The versioning format that we use is described [here](../../Documentation/Versioning). See ["Task Packages"](../../Documentation/TaskPackages.md#usage) for guidance on installing this package.


JohnTortugo · 2018-05-15T17:57:38Z

Hi @mmitche, @weshaggard / all; I believe we have sufficient material here to call this a minimal working version. Please, let me know what else I should work to get an approval for the merge :-)

src/Microsoft.DotNet.Build.Tasks.Versioning/src/GenerateVersioningDate.cs

+            }
+
+            // Leading zeros are only allowed in SemVer 1.0
+            if (IncludePadding)


Factoring reference to Buildtools framework. Some typos / minor fixes here and there.

src/Microsoft.DotNet.Build.Tasks.Versioning/src/GenerateVersioningDate.cs

+
+                dateFromBuildId = dateFromBuildId.ToUniversalTime();
+                GeneratedShortDate = CreateShortDate(dateFromBuildId, ComparisonDate);
+                GeneratedRevision = match.Groups[2].Value;


mmitche · 2018-05-15T21:59:41Z

Yeah, 2. Semver1 only. From: Divino César <notifications@github.com> Sent: Tuesday, May 15, 2018 2:58 PM To: dotnet/arcade <arcade@noreply.github.com> Cc: Matt Mitchell <mmitche@microsoft.com>; Mention <mention@noreply.github.com> Subject: Re: [dotnet/arcade] MSBuild Task for Semantic Versioning & Tests (#137) @JohnTortugo commented on this pull request.

________________________________ In src/Microsoft.DotNet.Build.Tasks.Versioning/src/GenerateVersioningDate.cs<https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fdotnet%2Farcade%2Fpull%2F137%23discussion_r188449173&data=02%7C01%7Cmmitche%40microsoft.com%7C95a6f0be6e5c4966a89608d5baaedd0c%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636620182555783776&sdata=P9hm9ttICt%2Fl8mxSg282HtjwzhB%2FytxTXcsGo0Eetis%3D&reserved=0>:

+ Match match = regex.Match(buildId);

+ + if (match.Success && match.Groups.Count > 2) + { + string dateFormat = "yyyyMMdd"; + DateTime dateFromBuildId; + + if (!DateTime.TryParseExact(match.Groups[1].Value, dateFormat, enUS, DateTimeStyles.AssumeLocal, out dateFromBuildId)) + { + Log.LogError("The OfficialBuildId doesn't follow the expected({0}.rr) format: '{1}'", dateFormat, match.Groups[1].Value); + return false; + } + + dateFromBuildId = dateFromBuildId.ToUniversalTime(); + GeneratedShortDate = CreateShortDate(dateFromBuildId, ComparisonDate); + GeneratedRevision = match.Groups[2].Value; Actually I wasn't aware that we needed padding for the Revision. How much should it be? Two digits? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fdotnet%2Farcade%2Fpull%2F137%23discussion_r188449173&data=02%7C01%7Cmmitche%40microsoft.com%7C95a6f0be6e5c4966a89608d5baaedd0c%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636620182555793784&sdata=vYiC8Vcq1tot0qxgwRPCL9vPGzcBbtiwoiEua1sdajE%3D&reserved=0>, or mute the thread<https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAIUisvh4gsE5jlcBuwVmvVyAskpT4woLks5ty09MgaJpZM4TnxL1&data=02%7C01%7Cmmitche%40microsoft.com%7C95a6f0be6e5c4966a89608d5baaedd0c%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636620182555803793&sdata=TYUk%2Fx6Ae7LJMF4ummYnZ%2FbTy8h5sbTPifoWvss1h8g%3D&reserved=0>.

…and SemVer 2.0.

JohnTortugo · 2018-05-15T22:31:28Z

Thanks. Pushed new update.

src/Microsoft.DotNet.Build.Tasks.Versioning/src/GenerateVersioningDate.cs

@@ -60,7 +60,7 @@ public override bool Execute()
            // If OfficialBuildId is passed in, then use that to calculate the version and revision.
            if (string.IsNullOrEmpty(OfficialBuildId))
            {
-                GeneratedRevision = "0";
+                GeneratedRevision = (IncludePadding) ? "00" : "0";


src/Microsoft.DotNet.Build.Tasks.Versioning/src/GenerateVersioningDate.cs

@@ -123,6 +124,11 @@ private bool SetVersionAndRevisionFromBuildId(string buildId)
                GeneratedShortDate = CreateShortDate(dateFromBuildId, ComparisonDate);
                GeneratedRevision = match.Groups[2].Value;

+                if (!IncludePadding)
+                {
+                    GeneratedRevision = int.Parse(GeneratedRevision).ToString();


src/Microsoft.DotNet.Build.Tasks.Versioning/targets/Versioning.targets

+  </Target>
+
+
+  <Target Name="CreateVersioningCacheFile" AfterTargets="GenerateVersions" Condition="'$(ShouldCreateVersionFileDuringBuild)'=='true'">


src/Microsoft.DotNet.Build.Tasks.Versioning/targets/Versioning.targets

+  <!-- If VersioningCacheFile exists already then import it; If it doesn't we are going to create it. -->
+  <Import Condition="Exists('$(VersioningCacheFile)')" Project="$(VersioningCacheFile)" />
+
+  <Target Name="GenerateVersions">


JohnTortugo · 2018-05-16T20:45:05Z

Any objection on merging this PR once currently running checks pass?

src/Microsoft.DotNet.Build.Tasks.Versioning/targets/Versioning.targets

@@ -0,0 +1,91 @@
+<!-- Copyright (c) .NET Foundation. All rights reserved. -->


alexperovich · 2018-05-16T21:18:00Z

MSBuild/nuget will only automatically import `sdk\Sdk.props` and `sdk\Sdk.targets` from packages used in Sdk elements, and `build\<PackageName>.props` and `build\<PackageName>.targets` for packages referenced via PackageReference. From: Wes Haggard <notifications@github.com> Sent: Wednesday, May 16, 2018 2:12 PM To: dotnet/arcade <arcade@noreply.github.com> Cc: Subscribed <subscribed@noreply.github.com> Subject: Re: [dotnet/arcade] MSBuild Task for Semantic Versioning & Tests (#137) @weshaggard commented on this pull request.

________________________________ In src/Microsoft.DotNet.Build.Tasks.Versioning/targets/Versioning.targets<https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fdotnet%2Farcade%2Fpull%2F137%23discussion_r188774366&data=02%7C01%7CAlex.Perovich%40microsoft.com%7Ce7406b67c8804338f37908d5bb71b808%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636621019449206149&sdata=W24Uoe%2Bm00ekD4FKEfN9W1Wuy20ycPIttlHJervTsVA%3D&reserved=0>:

@@ -0,0 +1,91 @@

+ Following the conventions of all our other tools packages this targets/props file should be called Microsoft.DotNet.Build.Tasks.Versioning.props/targets. In fact I think it might be needed to have nuget automatically reference theses files for projects that reference the package. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub<https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fdotnet%2Farcade%2Fpull%2F137%23pullrequestreview-120822207&data=02%7C01%7CAlex.Perovich%40microsoft.com%7Ce7406b67c8804338f37908d5bb71b808%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636621019449216153&sdata=dJlYYwCX4bxaACApDSRdg8B%2BbW0r0GCTX%2FO5dj82a3k%3D&reserved=0>, or mute the thread<https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAKE3IlGh-BdkVOzj8_EEM4a535A5Zr2Kks5tzJY3gaJpZM4TnxL1&data=02%7C01%7CAlex.Perovich%40microsoft.com%7Ce7406b67c8804338f37908d5bb71b808%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636621019449216153&sdata=ZW54ytxI9HiOeZDOVI7%2B2JbFKUi7K5cggqnIawCVZcY%3D&reserved=0>.

JohnTortugo added 4 commits April 25, 2018 17:08

First draft of SemanticVersioning Task

8204109

Adding MSBuild ToolTask for wrapping Git commands. Work in progress.

3d3c28d

Creating TestUtil project; Removing Git MSBuild Tasks.

ca14bc7

Fixing some typos.

47fce46

JohnTortugo self-assigned this Apr 26, 2018

JohnTortugo requested review from markwilkie and mmitche April 26, 2018 20:58

Adjusting projects to use RoslynTools-Repotoolset

d71f109

weshaggard reviewed Apr 27, 2018

View reviewed changes

src/Microsoft.DotNet.Build.Tasks.SemVer/SemVer.cs Outdated

namespace Microsoft.DotNet.Build.Tasks.SemVer

{

public class SemVer : Task

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

weshaggard reviewed Apr 27, 2018

View reviewed changes

First complete draft of versioning task implementation.

9f7f3e8

mmitche reviewed Apr 30, 2018

View reviewed changes

Changes after PR feedback (Renamings) + Some more tests.

e87ed24

JohnTortugo changed the title ~~(DRAFT) MSBuild Task for Semantic Versioning & Tests~~ MSBuild Task for Semantic Versioning & Tests May 1, 2018

rainersigwald reviewed May 1, 2018

View reviewed changes

mmitche reviewed May 1, 2018

View reviewed changes

src/Microsoft.DotNet.Build.Tasks.SemVer/SemVer.cs Outdated

{

public class SemVer : Task

{

private Dictionary<string, string> formats = new Dictionary<string, string> {

This comment was marked as spam.

Sign in to view

mmitche reviewed May 1, 2018

View reviewed changes

src/Microsoft.DotNet.Build.Tasks.SemVer/SemVer.cs Outdated

VersionString = formats[VersionString];

}

if ((VersionString.Contains("{major}") && Major == 0) ||

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

mmitche reviewed May 1, 2018

View reviewed changes

src/Microsoft.DotNet.Build.Tasks.SemVer/SemVer.cs Outdated

{

VersionString = FormatString.ToLower();

if (formats.ContainsKey(VersionString))

This comment was marked as spam.

Sign in to view

mmitche requested changes May 1, 2018

View reviewed changes

JohnTortugo added 3 commits May 2, 2018 14:56

Changes after PR feedback: Dropping the use of custom MSBuild tasks.

ae937e9

Fixing some typos and removing unused packages.

8bcf390

Importing GenerateCurrentVersion.cs from buildtools; We will probably…

e723275

… need some kind of date manipulation eventually.

mmitche reviewed May 7, 2018

View reviewed changes

src/Microsoft.DotNet.Build.Tasks.Versioning/README.md Outdated

===============================

Task package which handles generation of version strings.

The format that we use is described here: Documentation/Versioning.md

This comment was marked as spam.

Sign in to view

mmitche reviewed May 7, 2018

View reviewed changes

src/Microsoft.DotNet.Build.Tasks.Versioning/src/GenerateVersioningDate.cs Outdated

if (months > 0) //only allow dates after comparedate

{

return string.Format("{0}{1}", months.ToString("D" + (Padding - 2)), seedDate.Day.ToString("D2"));

}

This comment was marked as spam.

Sign in to view

mmitche reviewed May 7, 2018

View reviewed changes

src/Microsoft.DotNet.Build.Tasks.Versioning/Versioning.props Outdated

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

<Target Name="Versioning">

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

Handling SemVerOne leading zeros.

c3117e1

Adding unit tests to GenerateVersioningDate task. Some renaming in a …

73d58a2

…few places.

JohnTortugo added 2 commits May 14, 2018 15:14

Adding some tests for Versioning Target.

638c3f5

Improving documentation and adding one more test case.

bcd8573

joperezr reviewed May 15, 2018

View reviewed changes

src/Microsoft.DotNet.Build.Tasks.Versioning/src/GenerateVersioningDate.cs Outdated

}

// Leading zeros are only allowed in SemVer 1.0

if (IncludePadding)

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

mmitche approved these changes May 15, 2018

View reviewed changes

Adding Versioning DLL to signing list.

93e520e

Factoring reference to Buildtools framework. Some typos / minor fixes here and there.

weshaggard reviewed May 15, 2018

View reviewed changes

Fixing padding for Revision field when extracted for OfficialBuildId …

8539181

…and SemVer 2.0.

weshaggard reviewed May 15, 2018

View reviewed changes

joperezr reviewed May 15, 2018

View reviewed changes

JohnTortugo added 2 commits May 15, 2018 16:22

Adding more test cases; Fixing padding again.

845028f

Adding other DLLs to SignToolData.json

78300c8

JohnTortugo mentioned this pull request May 16, 2018

Implement the correct dependency chaining for the Versioning Task #176

Closed

weshaggard reviewed May 16, 2018

View reviewed changes

src/Microsoft.DotNet.Build.Tasks.Versioning/targets/Versioning.targets Outdated

@@ -0,0 +1,91 @@



This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

Renaming .targets/.props files

30f54b9

JohnTortugo closed this May 17, 2018

JohnTortugo mentioned this pull request May 17, 2018

MSBuild Versioning Task #178

Closed

		<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

		<Target Name="Versioning">

		@@ -0,0 +1,134 @@
		# Microsoft.DotNet.Build.Tasks.Versioning

		Task package which handles generation of version strings. The versioning format that we use is described [here](../../Documentation/Versioning). See ["Task Packages"](../../Documentation/TaskPackages.md#usage) for guidance on installing this package.

		</Target>


		<Target Name="CreateVersioningCacheFile" AfterTargets="GenerateVersions" Condition="'$(ShouldCreateVersionFileDuringBuild)'=='true'">

		@@ -0,0 +1,91 @@
		<!-- Copyright (c) .NET Foundation. All rights reserved. -->

MSBuild Task for Semantic Versioning & Tests #137

MSBuild Task for Semantic Versioning & Tests #137

Conversation

JohnTortugo commented Apr 26, 2018 • edited Loading

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

mmitche left a comment

Choose a reason for hiding this comment

weshaggard commented May 1, 2018

JohnTortugo commented May 1, 2018 • edited Loading

JohnTortugo commented May 7, 2018

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

weshaggard commented May 14, 2018

JohnTortugo commented May 14, 2018

weshaggard commented May 14, 2018

joperezr commented May 14, 2018

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

JohnTortugo commented May 15, 2018

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

mmitche commented May 15, 2018 via email

JohnTortugo commented May 15, 2018

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

JohnTortugo commented May 16, 2018

This comment was marked as spam.

This comment was marked as spam.

alexperovich commented May 16, 2018 via email

JohnTortugo commented Apr 26, 2018 •

edited

Loading

JohnTortugo commented May 1, 2018 •

edited

Loading