Add checks for version tags

Author: sandrofigo

.nuke/build.schema.json

@@ -6,6 +6,9 @@
     "build": {
       "type": "object",
       "properties": {
+        "ChangelogFile": {
+          "type": "string"
+        },
         "CheckForUnityMetaFilesExcludeDirectories": {
           "type": "array",
           "items": {
@@ -84,15 +87,15 @@
           "items": {
             "type": "string",
             "enum": [
-              "CheckChangelogVersionMatchesGitTagVersion",
-              "CheckChangelogVersionMatchesUnityPackageVersion",
+              "ChangelogVersionMatchesGitTagVersion",
               "CheckForUnityMetaFiles",
               "Clean",
               "Compile",
               "Publish",
               "PublishGitHubRelease",
               "Restore",
-              "Test"
+              "Test",
+              "UnityPackageVersionMatchesGitTagVersion"
             ]
           }
         },
@@ -102,22 +105,25 @@
           "items": {
             "type": "string",
             "enum": [
-              "CheckChangelogVersionMatchesGitTagVersion",
-              "CheckChangelogVersionMatchesUnityPackageVersion",
+              "ChangelogVersionMatchesGitTagVersion",
               "CheckForUnityMetaFiles",
               "Clean",
               "Compile",
               "Publish",
               "PublishGitHubRelease",
               "Restore",
-              "Test"
+              "Test",
+              "UnityPackageVersionMatchesGitTagVersion"
             ]
           }
         },
         "UnitTestProject": {
           "type": "string",
           "description": "Path to a solution file that is automatically loaded"
         },
+        "UnityPackageFile": {
+          "type": "string"
+        },
         "Verbosity": {
           "type": "string",
           "description": "Logging verbosity during build execution. Default is 'Normal'",

.nuke/parameters.json

@@ -3,5 +3,7 @@
   "UnitTestProject": "./tests/tests.csproj",
   "CheckForUnityMetaFilesIncludeDirectories": [
     "./src/Assets/SimpleCodeGenerator"
-  ]
+  ],
+  "ChangelogFile": "./CHANGELOG.md",
+  "UnityPackageFile": "./src/Assets/SimpleCodeGenerator/package.json"
 }

build/Build.cs

@@ -25,7 +25,7 @@
     InvokedTargets = new[] { nameof(Publish) },
     PublishCondition = "always()"
 )]
-class Build : NukeBuild, ICheckForUnityMetaFiles, ICheckChangelogVersionMatchesUnityPackageVersion, ICheckChangelogVersionMatchesGitTagVersion, IPublishGitHubRelease
+class Build : NukeBuild, ICheckForUnityMetaFiles, IUnityPackageVersionMatchesGitTagVersion, IChangelogVersionMatchesGitTagVersion, IPublishGitHubRelease
 {
     public static int Main() => Execute<Build>(x => x.Publish);
 
@@ -35,9 +35,6 @@ class Build : NukeBuild, ICheckForUnityMetaFiles, ICheckChangelogVersionMatchesU
     [Solution]
     readonly Solution UnitTestProject;
 
-    [GitRepository]
-    readonly GitRepository GitRepository;
-
     Target Clean => _ => _
         .Executes(() =>
         {
@@ -56,6 +53,7 @@ class Build : NukeBuild, ICheckForUnityMetaFiles, ICheckChangelogVersionMatchesU
 
     Target Compile => _ => _
         .DependsOn(Restore)
+        .DependsOn<ICheckForUnityMetaFiles>()
         .Executes(() =>
         {
             DotNetTasks.DotNetBuild(settings => settings
@@ -81,6 +79,9 @@ class Build : NukeBuild, ICheckForUnityMetaFiles, ICheckChangelogVersionMatchesU
 
     Target Publish => _ => _
         .DependsOn(Test)
-        .DependsOn<ICheckForUnityMetaFiles>()
-        .Triggers<IPublishGitHubRelease>();
+        .Triggers<IPublishGitHubRelease>()
+        .Executes(() =>
+        {
+            Log.Debug("IsServerBuild: {IsServerBuild}", IsServerBuild);
+        });
 }

build/GitRepositoryExtensions.cs

@@ -1,4 +1,6 @@
-using System.Linq;
+// #define MOCK_GIT_TAG
+
+using System.Linq;
 using NuGet.Versioning;
 using Nuke.Common;
 using Nuke.Common.Git;
@@ -8,13 +10,21 @@ public static class GitRepositoryExtensions
 {
     public static bool CurrentCommitHasVersionTag(this GitRepository gitRepository)
     {
+#if MOCK_GIT_TAG
+        return true;
+#endif
+
         var versionTagsOnCurrentCommit = gitRepository.Tags.Select(t => SemanticVersion.TryParse(t.TrimStart('v'), out SemanticVersion v) ? v : null).WhereNotNull();
 
         return versionTagsOnCurrentCommit.Any();
     }
 
-    public static SemanticVersion GetLatestVersionTag(this GitRepository gitRepository)
+    public static SemanticVersion GetLatestVersionTagOnCurrentCommit(this GitRepository gitRepository)
     {
+#if MOCK_GIT_TAG
+        return new SemanticVersion(1, 2, 3);
+#endif
+
         var versionTagsOnCurrentCommit = gitRepository.Tags.Select(t => SemanticVersion.TryParse(t.TrimStart('v'), out SemanticVersion v) ? v : null).WhereNotNull().OrderByDescending(t => t).ToArray();
 
         Assert.True(versionTagsOnCurrentCommit.Any(), $"The current commit '{gitRepository.Commit}' has no valid tag!");

build/IChangelogVersionMatchesGitTagVersion.cs

@@ -0,0 +1,33 @@
+using System.Linq;
+using NuGet.Versioning;
+using Nuke.Common;
+using Nuke.Common.ChangeLog;
+using Nuke.Common.Git;
+using Nuke.Common.IO;
+using Serilog;
+
+interface IChangelogVersionMatchesGitTagVersion : INukeBuild
+{
+    [GitRepository] private GitRepository GitRepository => TryGetValue(() => GitRepository);
+
+    [Parameter] AbsolutePath ChangelogFile => TryGetValue(() => ChangelogFile);
+
+    Target ChangelogVersionMatchesGitTagVersion => _ => _
+        .OnlyWhenStatic(() => GitRepository.CurrentCommitHasVersionTag())
+        .Executes(() =>
+        {
+            SemanticVersion versionFromChangelog = GetLatestVersionFromChangelog(ChangelogFile);
+            SemanticVersion versionFromGitTag = GitRepository.GetLatestVersionTagOnCurrentCommit();
+
+            Assert.True(versionFromChangelog == versionFromGitTag, $"The version {versionFromChangelog} from the changelog does not match the version {versionFromGitTag} from the git tag!");
+            
+            Log.Information("Changelog version and git tag version match");
+        });
+
+    static SemanticVersion GetLatestVersionFromChangelog(AbsolutePath pathToChangelogFile)
+    {
+        Assert.True(pathToChangelogFile != null, "No path has been provided!");
+        
+        return ChangelogTasks.ReadChangelog(pathToChangelogFile).ReleaseNotes.MaxBy(n => n.Version)?.Version;
+    }
+}

build/ICheckChangelogVersionMatchesGitTagVersion.cs

@@ -1,4 +1,5 @@
 using Nuke.Common;
+using Nuke.Common.CI.GitHubActions;
 using Nuke.Common.Git;
 using Serilog;
 
@@ -9,8 +10,9 @@ interface IPublishGitHubRelease : INukeBuild
 
     Target PublishGitHubRelease => _ => _
         .OnlyWhenStatic(() => GitRepository.CurrentCommitHasVersionTag())
-        .DependsOn<ICheckChangelogVersionMatchesUnityPackageVersion>()
-        .DependsOn<ICheckChangelogVersionMatchesGitTagVersion>()
+        .OnlyWhenStatic(() => IsServerBuild)
+        .DependsOn<IUnityPackageVersionMatchesGitTagVersion>()
+        .DependsOn<IChangelogVersionMatchesGitTagVersion>()
         .Executes(() =>
         {
             Log.Warning("TODO");

build/ICheckChangelogVersionMatchesUnityPackageVersion.cs

@@ -0,0 +1,34 @@
+using System.IO;
+using Newtonsoft.Json;
+using NuGet.Versioning;
+using Nuke.Common;
+using Nuke.Common.Git;
+using Nuke.Common.IO;
+using Serilog;
+
+interface IUnityPackageVersionMatchesGitTagVersion : INukeBuild
+{
+    [GitRepository] private GitRepository GitRepository => TryGetValue(() => GitRepository);
+
+    [Parameter] AbsolutePath UnityPackageFile => TryGetValue(() => UnityPackageFile);
+
+    Target UnityPackageVersionMatchesGitTagVersion => _ => _
+        .OnlyWhenStatic(() => GitRepository.CurrentCommitHasVersionTag())
+        .Executes(() =>
+        {
+            SemanticVersion versionFromUnityPackageFile = GetVersionFromUnityPackageFile(UnityPackageFile);
+            SemanticVersion versionFromGitTag = GitRepository.GetLatestVersionTagOnCurrentCommit();
+
+            Assert.True(versionFromUnityPackageFile == versionFromGitTag, $"The version {versionFromUnityPackageFile} from the Unity package file does not match the version {versionFromGitTag} from the git tag!");
+            
+            Log.Information("Unity package version and git tag version match");
+        });
+
+    static SemanticVersion GetVersionFromUnityPackageFile(AbsolutePath pathToUnityPackageFile)
+    {
+        Assert.True(pathToUnityPackageFile != null, "No path has been provided!");
+        
+        dynamic packageFile = JsonConvert.DeserializeObject(File.ReadAllText(pathToUnityPackageFile));
+        return SemanticVersion.Parse(packageFile.version.ToString());
+    }
+}