291.1 release notes (#1860)

* Revert "Added ability to run Dockerfile.SUFFIX ContainerAction (#1738)"

20b7e86e47

* 291.1 release notes

releaseNote.md

@@ -1,5 +1,4 @@
 ## Features
-- Relaxed naming requirements for dockerfiles (e.g. `Dockerfile.test` can now be built) (#1738)
 
 ## Bugs
 - Fixed a bug where windows path separators were used in generated folders (#1617)

releaseVersion

@@ -1 +1 @@
-<Update to ./src/runnerversion when creating release>
+2.291.1

src/Runner.Worker/ActionManager.cs

@@ -1004,7 +1004,7 @@ namespace GitHub.Runner.Worker
                 if (actionDefinitionData.Execution.ExecutionType == ActionExecutionType.Container)
                 {
                     var containerAction = actionDefinitionData.Execution as ContainerActionExecutionData;
-                    if (DockerUtil.IsDockerfile(containerAction.Image))
+                    if (containerAction.Image.EndsWith("Dockerfile") || containerAction.Image.EndsWith("dockerfile"))
                     {
                         var dockerFileFullPath = Path.Combine(actionEntryDirectory, containerAction.Image);
                         executionContext.Debug($"Dockerfile for action: '{dockerFileFullPath}'.");

src/Runner.Worker/Container/DockerUtil.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
 using System.Text.RegularExpressions;
 
 namespace GitHub.Runner.Worker.Container
@@ -18,7 +17,7 @@ namespace GitHub.Runner.Worker.Container
             string pattern = $"^(?<{targetPort}>\\d+)/(?<{proto}>\\w+) -> (?<{host}>.+):(?<{hostPort}>\\d+)$";
 
             List<PortMapping> portMappings = new List<PortMapping>();
-            foreach (var line in portMappingLines)
+            foreach(var line in portMappingLines)
             {
                 Match m = Regex.Match(line, pattern, RegexOptions.None, TimeSpan.FromSeconds(1));
                 if (m.Success)
@@ -62,15 +61,5 @@ namespace GitHub.Runner.Worker.Container
             }
             return "";
         }
-
-        public static bool IsDockerfile(string image)
-        {
-            if (image.StartsWith("docker://", StringComparison.OrdinalIgnoreCase))
-            {
-                return false;
-            }
-            var imageWithoutPath = image.Split('/').Last();
-            return imageWithoutPath.StartsWith("Dockerfile.") || imageWithoutPath.StartsWith("dockerfile.") || imageWithoutPath.EndsWith("Dockerfile") || imageWithoutPath.EndsWith("dockerfile");
-        }
     }
 }

src/Runner.Worker/Handlers/ContainerActionHandler.cs

@@ -44,8 +44,9 @@ namespace GitHub.Runner.Worker.Handlers
             {
                 Data.Image = Data.Image.Substring("docker://".Length);
             }
-            else if (DockerUtil.IsDockerfile(Data.Image))
+            else if (Data.Image.EndsWith("Dockerfile") || Data.Image.EndsWith("dockerfile"))
             {
+                // ensure docker file exist
                 var dockerFile = Path.Combine(ActionDirectory, Data.Image);
                 ArgUtil.File(dockerFile, nameof(Data.Image));
 
@@ -67,10 +68,6 @@ namespace GitHub.Runner.Worker.Handlers
 
                 Data.Image = imageName;
             }
-            else
-            {
-                throw new InvalidOperationException($"'{Data.Image}' should be either '[path]/Dockerfile' or 'docker://image[:tag]'.");
-            }
 
             string type = Action.Type == Pipelines.ActionSourceType.Repository ? "Dockerfile" : "DockerHub";
             // Set extra telemetry base on the current context.

src/Test/L0/Container/DockerUtilL0.cs

@@ -144,48 +144,5 @@ namespace GitHub.Runner.Common.Tests.Worker.Container
             var actual = DockerUtil.ParseRegistryHostnameFromImageName(input);
             Assert.Equal(expected, actual);
         }
-
-        [Theory]
-        [Trait("Level", "L0")]
-        [Trait("Category", "Worker")]
-        [InlineData("dockerhub/repo", false)]
-        [InlineData("debian:latest", false)]
-        [InlineData("something/dockerfileimage", false)]
-        [InlineData("ghcr.io/docker/dockerfile", true)] // should be false but might break the current workflows
-        [InlineData("Dockerfile", true)]
-        [InlineData("Dockerfile.", true)]
-        [InlineData(".Dockerfile", true)]
-        [InlineData(".Dockerfile.", false)]
-        [InlineData("dockerfile", true)]
-        [InlineData("dockerfile.", true)]
-        [InlineData(".dockerfile", true)]
-        [InlineData(".dockerfile.", false)]
-        [InlineData("Dockerfile.test", true)]
-        [InlineData("test.Dockerfile", true)]
-        [InlineData("docker/dockerfile:latest", false)]
-        [InlineData("/some/path/dockerfile:latest", false)]
-        [InlineData("dockerfile:latest", false)]
-        [InlineData("Dockerfile:latest", false)]
-        [InlineData("dockerfile-latest", false)]
-        [InlineData("Dockerfile-latest", false)]
-        [InlineData("dockerfile.latest", true)]
-        [InlineData("Dockerfile.latest", true)]
-        [InlineData("../dockerfile/dockerfileone", false)]
-        [InlineData("../Dockerfile/dockerfileone", false)]
-        [InlineData("../dockerfile.test", true)]
-        [InlineData("../Dockerfile.test", true)]
-        [InlineData("./dockerfile/image", false)]
-        [InlineData("./Dockerfile/image", false)]
-        [InlineData("example/Dockerfile.test", true)]
-        [InlineData("./example/Dockerfile.test", true)]
-        [InlineData("example/test.dockerfile", true)]
-        [InlineData("./example/test.dockerfile", true)]
-        [InlineData("docker://Dockerfile", false)]
-        [InlineData("docker://ubuntu:latest", false)]
-        public void IsDockerfile(string input, bool expected)
-        {
-            var actual = DockerUtil.IsDockerfile(input);
-            Assert.Equal(expected, actual);
-        }
     }
 }

src/runnerversion

@@ -1 +1 @@
-2.291.0
+2.291.1