Merge pull request #2450 from DavidBoike/fix-github-actions

For GitHub Actions, outgoing env vars need to be written to $GITHUV_ENV file

Author: asbjornu

src/GitVersionCore.Tests/BuildAgents/GitHubActionsTests.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using System.IO;
 using GitVersion;
 using GitVersion.BuildAgents;
 using GitVersionCore.Tests.Helpers;
@@ -15,6 +16,7 @@ public class GitHubActionsTests : TestBase
     {
         private IEnvironment environment;
         private GitHubActions buildServer;
+        private string githubSetEnvironmentTempFilePath;
 
         [SetUp]
         public void SetUp()
@@ -26,12 +28,21 @@ public void SetUp()
             environment = sp.GetService<IEnvironment>();
             buildServer = sp.GetService<GitHubActions>();
             environment.SetEnvironmentVariable(GitHubActions.EnvironmentVariableName, "true");
+
+            githubSetEnvironmentTempFilePath = Path.GetTempFileName();
+            environment.SetEnvironmentVariable(GitHubActions.GitHubSetEnvTempFileEnvironmentVariableName, githubSetEnvironmentTempFilePath);
         }
 
         [TearDown]
         public void TearDown()
         {
             environment.SetEnvironmentVariable(GitHubActions.EnvironmentVariableName, null);
+            environment.SetEnvironmentVariable(GitHubActions.GitHubSetEnvTempFileEnvironmentVariableName, null);
+            if (githubSetEnvironmentTempFilePath != null && File.Exists(githubSetEnvironmentTempFilePath))
+            {
+                File.Delete(githubSetEnvironmentTempFilePath);
+                githubSetEnvironmentTempFilePath = null;
+            }
         }
 
         [Test]
@@ -96,19 +107,17 @@ public void GetCurrentBranchShouldHandlePullRequests()
             result.ShouldBe("refs/pull/1/merge");
         }
 
-        [TestCase("Something", "1.0.0",
-            "\"GitVersion_Something=1.0.0\" >> $GITHUB_ENV")]
-        public void GetSetParameterMessage(string key, string value, string expectedResult)
+        [Test]
+        public void GetSetParameterMessage()
         {
             // Assert
             environment.GetEnvironmentVariable("GitVersion_Something").ShouldBeNullOrWhiteSpace();
 
             // Act
-            var result = buildServer.GenerateSetParameterMessage(key, value);
+            var result = buildServer.GenerateSetParameterMessage("GitVersion_Something", "1.0.0");
 
             // Assert
-            result.ShouldContain(s => true, 1);
-            result.ShouldBeEquivalentTo(new[] { expectedResult });
+            result.ShouldContain(s => true, 0);
         }
 
         [Test]
@@ -141,11 +150,20 @@ public void ShouldWriteIntegration()
                 "Executing GenerateSetVersionMessage for 'GitHubActions'.",
                 "",
                 "Executing GenerateBuildLogOutput for 'GitHubActions'.",
-                "\"GitVersion_Major=1.0.0\" >> $GITHUB_ENV"
+                "Writing version variables to $GITHUB_ENV file for 'GitHubActions'."
             };
 
             string.Join(Environment.NewLine, list)
                 .ShouldBe(string.Join(Environment.NewLine, expected));
+
+            var expectedFileContents = new List<string>
+            {
+                "GitVersion_Major=1.0.0"
+            };
+
+            var actualFileContents = File.ReadAllLines(githubSetEnvironmentTempFilePath);
+
+            actualFileContents.ShouldBe(expectedFileContents);
         }
 
         [Test]

src/GitVersionCore/BuildAgents/GitHubActions.cs

@@ -1,5 +1,6 @@
 using GitVersion.Logging;
 using GitVersion.OutputVariables;
+using System.IO;
 
 namespace GitVersion.BuildAgents
 {
@@ -12,6 +13,8 @@ public GitHubActions(IEnvironment environment, ILog log) : base(environment, log
         }
 
         public const string EnvironmentVariableName = "GITHUB_ACTIONS";
+        public const string GitHubSetEnvTempFileEnvironmentVariableName = "GITHUB_ENV";
+
         protected override string EnvironmentVariable { get; } = EnvironmentVariableName;
 
         public override string GenerateSetVersionMessage(VersionVariables variables)
@@ -23,21 +26,44 @@ public override string GenerateSetVersionMessage(VersionVariables variables)
 
         public override string[] GenerateSetParameterMessage(string name, string value)
         {
+            // There is no equivalent function in GitHub Actions.
+
+            return new string[0];
+        }
+
+        public override void WriteIntegration(System.Action<string> writer, VersionVariables variables, bool updateBuildNumber = true)
+        {
+            base.WriteIntegration(writer, variables, updateBuildNumber);
+
             // https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#environment-files
-            // Example
-            // echo "name=action_state::yellow >> $GITHUB_ENV"
+            // The outgoing environment variables must be written to a temporary file (identified by the $GITHUB_ENV environment
+            // variable, which changes for every step in a workflow) which is then parsed. That file must also be UTF-8 or it will fail.
 
-            if (!string.IsNullOrWhiteSpace(value))
+            if (writer == null || !updateBuildNumber)
             {
-                var key = $"GitVersion_{name}";
+                return;
+            }
+
+            var gitHubSetEnvFilePath = this.Environment.GetEnvironmentVariable(GitHubSetEnvTempFileEnvironmentVariableName);
 
-                return new[]
+            if (gitHubSetEnvFilePath != null)
+            {
+                writer($"Writing version variables to $GITHUB_ENV file for '{GetType().Name}'.");
+                using (var streamWriter = File.AppendText(gitHubSetEnvFilePath)) // Already uses UTF-8 as required by GitHub
                 {
-                    $"\"{key}={value}\" >> $GITHUB_ENV"
-                };
+                    foreach (var variable in variables)
+                    {
+                        if (!string.IsNullOrEmpty(variable.Value))
+                        {
+                            streamWriter.WriteLine($"GitVersion_{variable.Key}={variable.Value}");
+                        }
+                    }
+                }
+            }
+            else
+            {
+                writer($"Unable to write GitVersion variables to ${GitHubSetEnvTempFileEnvironmentVariableName} because the environment variable is not set.");
             }
-
-            return new string[0];
         }
 
         public override string GetCurrentBranch(bool usingDynamicRepos)