nuke-build · leorg99 · Mar 31, 2024 · Mar 31, 2024 · Mar 31, 2024 · Mar 31, 2024
diff --git a/build/Build.GlobalSolution.cs b/build/Build.GlobalSolution.cs
@@ -15,7 +15,6 @@
 using Nuke.Common.Utilities;
 using Nuke.Utilities.Text.Yaml;
 using static Nuke.Common.ControlFlow;
-using static Nuke.Common.IO.FileSystemTasks;
 using static Nuke.Common.ProjectModel.SolutionModelTasks;
 using static Nuke.Common.Tools.Git.GitTasks;
 
@@ -67,18 +66,16 @@ IEnumerable<GitRepository> ExternalRepositories
 
             if ((RootDirectory / $"{Solution.FileName}.DotSettings").FileExists())
             {
-                CopyFile(
-                    source: RootDirectory / $"{Solution.FileName}.DotSettings",
+                (RootDirectory / $"{Solution.FileName}.DotSettings").Copy(
                     target: RootDirectory / $"{global.FileName}.DotSettings",
-                    FileExistsPolicy.Overwrite);
+                    policy: ExistsPolicy.FileOverwrite);
             }
 
             if ((RootDirectory / $"{Solution.FileName}.DotSettings.user").FileExists())
             {
-                CopyFile(
-                    source: RootDirectory / $"{Solution.FileName}.DotSettings.user",
+                (RootDirectory / $"{Solution.FileName}.DotSettings.user").Copy(
                     target: RootDirectory / $"{global.FileName}.DotSettings.user",
-                    FileExistsPolicy.Overwrite);
+                    policy: ExistsPolicy.FileOverwrite);
             }
         });
 }
diff --git a/...est.Test_testName=self-hosted-NoCustomGroup_attribute=GitHubActionsAttribute.verified.txt b/...est.Test_testName=self-hosted-NoCustomGroup_attribute=GitHubActionsAttribute.verified.txt
@@ -0,0 +1,89 @@
+# ------------------------------------------------------------------------------
+# <auto-generated>
+#
+#     This code was generated.
+#
+#     - To turn off auto-generation set:
+#
+#         [TestGitHubActions (AutoGenerate = false)]
+#
+#     - To trigger manual generation invoke:
+#
+#         nuke --generate-configuration GitHubActions_test --host GitHubActions
+#
+# </auto-generated>
+# ------------------------------------------------------------------------------
+
+name: test
+
+on: [push, pull_request]
+
+permissions:
+  contents: write
+  actions: read
+
+jobs:
+  ubuntu-latest:
+    name: ubuntu-latest
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: 'Cache: .nuke/temp, ~/.nuget/packages'
+        uses: actions/cache@v4
+        with:
+          path: |
+            .nuke/temp
+            ~/.nuget/packages
+          key: ${{ runner.os }}-${{ hashFiles('**/global.json', '**/*.csproj', '**/Directory.Packages.props') }}
+      - name: 'Run: Test'
+        run: ./build.cmd Test
+        env:
+          ApiKey: ${{ secrets.API_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: 'Publish: src'
+        uses: actions/upload-artifact@v4
+        with:
+          name: src
+          path: src
+      - name: 'Publish: test-results'
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results
+          path: output/test-results
+      - name: 'Publish: coverage-report.zip'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report.zip
+          path: output/coverage-report.zip
+  self-hosted:
+    name: self-hosted
+    runs-on: [ self-hosted, label1, label2 ]
+    steps:
+      - uses: actions/checkout@v3
+      - name: 'Cache: .nuke/temp, ~/.nuget/packages'
+        uses: actions/cache@v4
+        with:
+          path: |
+            .nuke/temp
+            ~/.nuget/packages
+          key: ${{ runner.os }}-${{ hashFiles('**/global.json', '**/*.csproj', '**/Directory.Packages.props') }}
+      - name: 'Run: Test'
+        run: ./build.cmd Test
+        env:
+          ApiKey: ${{ secrets.API_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: 'Publish: src'
+        uses: actions/upload-artifact@v4
+        with:
+          name: src
+          path: src
+      - name: 'Publish: test-results'
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results
+          path: output/test-results
+      - name: 'Publish: coverage-report.zip'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report.zip
+          path: output/coverage-report.zip
diff --git a/...ionGenerationTest.Test_testName=self-hosted_attribute=GitHubActionsAttribute.verified.txt b/...ionGenerationTest.Test_testName=self-hosted_attribute=GitHubActionsAttribute.verified.txt
@@ -0,0 +1,91 @@
+# ------------------------------------------------------------------------------
+# <auto-generated>
+#
+#     This code was generated.
+#
+#     - To turn off auto-generation set:
+#
+#         [TestGitHubActions (AutoGenerate = false)]
+#
+#     - To trigger manual generation invoke:
+#
+#         nuke --generate-configuration GitHubActions_test --host GitHubActions
+#
+# </auto-generated>
+# ------------------------------------------------------------------------------
+
+name: test
+
+on: [push, pull_request]
+
+permissions:
+  contents: write
+  actions: read
+
+jobs:
+  ubuntu-latest:
+    name: ubuntu-latest
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: 'Cache: .nuke/temp, ~/.nuget/packages'
+        uses: actions/cache@v4
+        with:
+          path: |
+            .nuke/temp
+            ~/.nuget/packages
+          key: ${{ runner.os }}-${{ hashFiles('**/global.json', '**/*.csproj', '**/Directory.Packages.props') }}
+      - name: 'Run: Test'
+        run: ./build.cmd Test
+        env:
+          ApiKey: ${{ secrets.API_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: 'Publish: src'
+        uses: actions/upload-artifact@v4
+        with:
+          name: src
+          path: src
+      - name: 'Publish: test-results'
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results
+          path: output/test-results
+      - name: 'Publish: coverage-report.zip'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report.zip
+          path: output/coverage-report.zip
+  self-hosted:
+    name: self-hosted
+    runs-on:
+      group: SomeGroup
+      labels: [ self-hosted, label1, label2 ]
+    steps:
+      - uses: actions/checkout@v3
+      - name: 'Cache: .nuke/temp, ~/.nuget/packages'
+        uses: actions/cache@v4
+        with:
+          path: |
+            .nuke/temp
+            ~/.nuget/packages
+          key: ${{ runner.os }}-${{ hashFiles('**/global.json', '**/*.csproj', '**/Directory.Packages.props') }}
+      - name: 'Run: Test'
+        run: ./build.cmd Test
+        env:
+          ApiKey: ${{ secrets.API_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: 'Publish: src'
+        uses: actions/upload-artifact@v4
+        with:
+          name: src
+          path: src
+      - name: 'Publish: test-results'
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results
+          path: output/test-results
+      - name: 'Publish: coverage-report.zip'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report.zip
+          path: output/coverage-report.zip
diff --git a/source/Nuke.Common.Tests/CI/ConfigurationGenerationTest.cs b/source/Nuke.Common.Tests/CI/ConfigurationGenerationTest.cs
@@ -162,6 +162,41 @@ public class TestBuild : NukeBuild
                 }
             );
 
+            yield return
+            (
+                "self-hosted",
+                new TestGitHubActionsAttribute(
+                    GitHubActionsImage.UbuntuLatest,
+                    GitHubActionsImage.SelfHosted)
+                {
+                    On = new[] { GitHubActionsTrigger.Push, GitHubActionsTrigger.PullRequest },
+                    CustomRunnerLabels = ["label1", "label2"],
+                    CustomRunnerGroup = "SomeGroup",
+                    InvokedTargets = new[] { nameof(Test) },
+                    ImportSecrets = new[] { nameof(ApiKey) },
+                    EnableGitHubToken = true,
+                    WritePermissions = new[] { GitHubActionsPermissions.Contents },
+                    ReadPermissions = new[] { GitHubActionsPermissions.Actions }
+                }
+            );
+
+            yield return
+            (
+                "self-hosted-NoCustomGroup",
+                new TestGitHubActionsAttribute(
+                    GitHubActionsImage.UbuntuLatest,
+                    GitHubActionsImage.SelfHosted)
+                {
+                    On = new[] { GitHubActionsTrigger.Push, GitHubActionsTrigger.PullRequest },
+                    CustomRunnerLabels = ["label1", "label2"],
+                    InvokedTargets = new[] { nameof(Test) },
+                    ImportSecrets = new[] { nameof(ApiKey) },
+                    EnableGitHubToken = true,
+                    WritePermissions = new[] { GitHubActionsPermissions.Contents },
+                    ReadPermissions = new[] { GitHubActionsPermissions.Actions }
+                }
+            );
+
             yield return
             (
                 null,

diff --git a/source/Nuke.Common.Tests/Nuke.Common.Tests.csproj b/source/Nuke.Common.Tests/Nuke.Common.Tests.csproj
@@ -8,4 +8,11 @@
     <ProjectReference Include="..\Nuke.Common\Nuke.Common.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Update="CI\ConfigurationGenerationTest.Test_testName=self-hosted_attribute=GitHubActionsAttribute.verified.txt">
+      <ParentFile>$([System.String]::Copy('%(FileName)').Split('.')[0])</ParentFile>
+      <DependentUpon>%(ParentFile).cs</DependentUpon>
+    </None>
+  </ItemGroup>
+
 </Project>
diff --git a/source/Nuke.Common/CI/GitHubActions/Configuration/GitHubActionsJob.cs b/source/Nuke.Common/CI/GitHubActions/Configuration/GitHubActionsJob.cs
@@ -1,4 +1,4 @@
-// Copyright 2023 Maintainers of NUKE.
+// Copyright 2023 Maintainers of NUKE.
 // Distributed under the MIT License.
 // https://github.com/nuke-build/nuke/blob/master/LICENSE
 
@@ -16,6 +16,8 @@ public class GitHubActionsJob : ConfigurationEntity
 {
     public string Name { get; set; }
     public GitHubActionsImage Image { get; set; }
+    public string[] CustomRunnerLabels { get; set; } = [];
+    public string CustomRunnerGroup { get; set; }
     public int TimeoutMinutes { get; set; }
     public string ConcurrencyGroup { get; set; }
     public bool ConcurrencyCancelInProgress { get; set; }
@@ -28,7 +30,8 @@ public override void Write(CustomFileWriter writer)
         using (writer.Indent())
         {
             writer.WriteLine($"name: {Name}");
-            writer.WriteLine($"runs-on: {Image.GetValue()}");
+
+            WriteRunsOn(writer);
 
             if (TimeoutMinutes > 0)
             {
@@ -63,4 +66,36 @@ public override void Write(CustomFileWriter writer)
             }
         }
     }
+
+    private void WriteRunsOn(CustomFileWriter writer)
+    {
+        if (Image != GitHubActionsImage.SelfHosted)
+        {
+            writer.WriteLine($"runs-on: {Image.GetValue()}");
+            return;
+        }
+
+        if (!CustomRunnerGroup.IsNullOrWhiteSpace())
+        {
+            writer.WriteLine($"runs-on:");
+
+            using (writer.Indent())
+            {
+                writer.WriteLine($"group: {CustomRunnerGroup}");
+
+                if (CustomRunnerLabels.Length > 0)
+                {
+                    writer.WriteInlineArray("labels", [Image.GetValue(), .. CustomRunnerLabels]);
+                }
+            }
+        }
+        else if (CustomRunnerLabels.Length > 0)
+        {
+            writer.WriteInlineArray("runs-on", [Image.GetValue(), .. CustomRunnerLabels]);
+        }
+        else
+        {
+            writer.WriteLine($"runs-on: {Image.GetValue()}");
+        }
+    }
 }
diff --git a/source/Nuke.Common/CI/GitHubActions/Configuration/GithubActionsCustomWriterExtensions.cs b/source/Nuke.Common/CI/GitHubActions/Configuration/GithubActionsCustomWriterExtensions.cs
@@ -0,0 +1,28 @@
+// Copyright 2023 Maintainers of NUKE.
+// Distributed under the MIT License.
+// https://github.com/nuke-build/nuke/blob/master/LICENSE
+
+using System;
+using System.Linq;
+using Nuke.Common.Utilities;
+
+namespace Nuke.Common.CI.GitHubActions.Configuration;
+
+public static class GithubActionsCustomWriterExtensions
+{
+    public static void WriteInlineArray(this CustomFileWriter writer, string property, string[] values)
+    {
+        if (values.Length == 0)
+        {
+            return;
+        }
+
+        if (values.Length <= 1)
+        {
+            writer.WriteLine($"{property}: {values.Single()}");
+            return;
+        }
+
+        writer.WriteLine($"{property}: [ {values.JoinCommaSpace()} ]");
+    }
+}
diff --git a/source/Nuke.Common/CI/GitHubActions/GitHubActionsAttribute.cs b/source/Nuke.Common/CI/GitHubActions/GitHubActionsAttribute.cs
@@ -80,6 +80,9 @@ public GitHubActionsAttribute(
 
     public string[] InvokedTargets { get; set; } = new string[0];
 
+    public string[] CustomRunnerLabels { get; set; } = [];
+    public string CustomRunnerGroup { get; set; }
+
     public GitHubActionsSubmodules Submodules
     {
         set => _submodules = value;
@@ -130,6 +133,8 @@ protected virtual GitHubActionsJob GetJobs(GitHubActionsImage image, IReadOnlyCo
                    Name = image.GetValue().Replace(".", "_"),
                    Steps = GetSteps(image, relevantTargets).ToArray(),
                    Image = image,
+                   CustomRunnerGroup = CustomRunnerGroup,
+                   CustomRunnerLabels = CustomRunnerLabels,
                    TimeoutMinutes = TimeoutMinutes,
                    ConcurrencyGroup = JobConcurrencyGroup,
                    ConcurrencyCancelInProgress = JobConcurrencyCancelInProgress