Add "GitVersioningCloud" alias to Cake.GitVersioning

Author: ap0llo

src/Cake.GitVersioning/GitVersioningAliases.cs

@@ -1,15 +1,11 @@
-using System.IO;
-using System.Reflection;
-using Cake.Core;
-using Cake.Core.Annotations;
-using Nerdbank.GitVersioning;
-
-namespace Cake.GitVersioning
+namespace Cake.GitVersioning
 {
     using System;
-    using System.Linq;
-
-    using Validation;
+    using System.IO;
+    using System.Reflection;
+    using Cake.Core;
+    using Cake.Core.Annotations;
+    using Nerdbank.GitVersioning;
 
     /// <summary>
     /// Contains functionality for using Nerdbank.GitVersioning.
@@ -45,5 +41,46 @@ public static VersionOracle GitVersioningGetVersion(this ICakeContext cakeContex
             var gitContext = GitContext.Create(fullProjectDirectory);
             return new VersionOracle(gitContext, cloudBuild: CloudBuild.Active);
         }
+
+        /// <summary>
+        /// Adds versioning information to the current build environment's variables.
+        /// </summary>
+        /// <example>
+        /// Task("SetBuildVersion")
+        ///     .Does(() =>
+        /// {
+        ///     GitVersioningCloud()
+        /// });
+        /// </example>
+        /// <param name="cakeContext">The context.</param>
+        /// <param name="projectDirectory">Directory to start the search for version.json.</param>
+        /// <param name="settings">The settings to use for updating variables.</param>
+        [CakeMethodAlias]
+        public static void GitVersioningCloud(this ICakeContext cakeContext, string projectDirectory = ".", GitVersioningCloudSettings settings = null)
+        {
+            var fullProjectDirectory = (new DirectoryInfo(projectDirectory)).FullName;
+
+            string directoryName = Path.GetDirectoryName(Assembly.GetAssembly(typeof(GitVersioningAliases)).Location);
+
+            if (string.IsNullOrWhiteSpace(directoryName))
+            {
+                throw new InvalidOperationException("Could not locate the Cake.GitVersioning library");
+            }
+
+            settings ??= new GitVersioningCloudSettings();
+
+            var cloudCommand = new CloudCommand(Console.Out, Console.Error);
+            cloudCommand.SetBuildVariables(
+                fullProjectDirectory,
+                settings.Metadata,
+                settings.Version,
+                settings.CISystem?.ToString(),
+                settings.AllVariables,
+                settings.CommonVariables,
+                settings.AdditionalVariables,
+                false
+            );
+        }
+
     }
 }

src/Cake.GitVersioning/GitVersioningCloudProvider.cs

@@ -0,0 +1,53 @@
+namespace Cake.GitVersioning
+{
+    /// <summary>
+    /// Defines the supported cloud build providers for the <see cref="GitVersioningAliases.GitVersioningCloud" /> alias.
+    /// </summary>
+    public enum GitVersioningCloudProvider
+    {
+        /// <summary>
+        /// Use AppVeyor cloud build provider.
+        /// </summary>
+        AppVeyor,
+
+        /// <summary>
+        /// Use Azure Pipeline / Visual Studio Team Services / TFS cloud build provider.
+        /// </summary>
+        VisualStudioTeamServices,
+
+        /// <summary>
+        /// Use GitHub Actions cloud build provider.
+        /// </summary>
+        GitHubActions,
+
+        /// <summary>
+        /// Use the TeamCity cloud build provider.
+        /// </summary>
+        TeamCity,
+
+        /// <summary>
+        /// Use the Atlassian Bamboo cloud build provider.
+        /// </summary>
+        AtlassianBamboo,
+
+        /// <summary>
+        /// Use the Jenkins cloud build provider.
+        /// </summary>
+        Jenkins,
+
+        /// <summary>
+        /// Use the GitLab CI cloud build provider.
+        /// </summary>
+        GitLab,
+
+        /// <summary>
+        /// Use the Travis CI cloud build provider.
+        /// </summary>
+        Travis,
+
+        /// <summary>
+        /// Use the Jetbrains Space cloud build provider.
+        /// </summary>
+        SpaceAutomation,
+    }
+}

src/Cake.GitVersioning/GitVersioningCloudSettings.cs

@@ -0,0 +1,42 @@
+namespace Cake.GitVersioning
+{
+    using System.Collections.Generic;
+
+    /// <summary>
+    /// Defines settings for the <see cref="GitVersioningAliases.GitVersioningCloud"/> alias.
+    /// </summary>
+    public class GitVersioningCloudSettings
+    {
+        /// <summary>
+        /// The string to use for the cloud build number. 
+        /// If not value os specified, the computed version will be used.
+        /// </summary>
+        public string Version { get; set; } = null;
+
+        /// <summary>
+        /// Adds an identifier to the build metadata part of a semantic version.
+        /// </summary>
+        public IList<string> Metadata { get; set; } = new List<string>();
+
+        /// <summary>
+        /// Force activation for a particular CI system. If not specified,
+        /// auto-detection will be used.
+        /// </summary>
+        public GitVersioningCloudProvider? CISystem { get; set; } = null;
+
+        /// <summary>
+        /// Defines ALL version variables as cloud build variables, with a "NBGV_" prefix.
+        /// </summary>
+        public bool AllVariables { get; set; } = false;
+
+        /// <summary>
+        /// Defines a few common version variables as cloud build variables, with a "Git" prefix.
+        /// </summary>
+        public bool CommonVariables { get; set; } = false;
+
+        /// <summary>
+        /// Additional cloud build variables to define.
+        /// </summary>
+        public IDictionary<string, string> AdditionalVariables { get; set; } = new Dictionary<string, string>();
+    }
+}

src/NerdBank.GitVersioning.Tests/GitVersioningCloudProviderTests.cs

@@ -0,0 +1,30 @@
+using System;
+using System.Linq;
+using Cake.GitVersioning;
+using Nerdbank.GitVersioning;
+using Xunit;
+
+/// <summary>
+/// Tests to verify the <see cref="GitVersioningCloudProvider"/> enum (part of the Cake integration) is up-to-date
+/// </summary>
+public class GitVersioningCloudProviderTests
+{
+    [Fact]
+    public void HasExpectedValues()
+    {
+        var expectedValues = CloudBuild.SupportedCloudBuilds.Select(cb => cb.GetType().Name);
+        var actualValues = Enum.GetNames(typeof(GitVersioningCloudProvider));
+
+        var missingValues = expectedValues.Except(actualValues);
+        Assert.True(
+            !missingValues.Any(),
+            $"Enumeration is missing the following values of supported cloud build providers: {string.Join(", ", missingValues)}"
+        );
+
+        var redundantValues = actualValues.Except(expectedValues);
+        Assert.True(
+            !redundantValues.Any(),
+            $"Enumeration contains values which were not found among supported cloud build providers: {string.Join(",", redundantValues)}"
+        );
+    }
+}

src/NerdBank.GitVersioning.Tests/NerdBank.GitVersioning.Tests.csproj

@@ -28,6 +28,7 @@
     <EmbeddedResource Include="repos\*" />
   </ItemGroup>
   <ItemGroup>
+    <ProjectReference Include="..\Cake.GitVersioning\Cake.GitVersioning.csproj" />
     <ProjectReference Include="..\Nerdbank.GitVersioning.Tasks\Nerdbank.GitVersioning.Tasks.csproj" />
     <ProjectReference Include="..\NerdBank.GitVersioning\NerdBank.GitVersioning.csproj" />
   </ItemGroup>