Allow to have overall status and status for every issue provider repo…

…rted to pull request (#287)
cake-contrib · Aug 24, 2022 · 4bb7299 · 4bb7299
1 parent 9f3eb99
commit 4bb7299
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 22 deletions.
diff --git a/...cipe/Cake.Frosting.Issues.Recipe/Context/Parameters/IIssuesParametersPullRequestSystem.cs b/...cipe/Cake.Frosting.Issues.Recipe/Context/Parameters/IIssuesParametersPullRequestSystem.cs
@@ -54,13 +54,16 @@ public interface IIssuesParametersPullRequestSystem
         Dictionary<string, IProviderIssueLimits> ProviderIssueLimits { get; }
 
         /// <summary>
-        /// Gets or sets a value indicating whether a status on the pull request should be set.
+        /// Gets or sets a value indicating whether a status on the pull request should be set if there are any issues found.
+        /// The status is succeeded if there are no issues and fails as soon as issues from any issue provider or run have been found.
+        /// Use <see cref="ShouldSetSeparatePullRequestStatusForEachIssueProviderAndRun"/> to report additional status for issues of every issue provider and run.
         /// Default value is <c>true</c>.
         /// </summary>
         bool ShouldSetPullRequestStatus { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether a separate status should be set for issues of every issue provider and run.
+        /// Use <see cref="ShouldSetPullRequestStatus"/> to report status across all issue providers and runs.
         /// Default value is <c>false</c>.
         /// </summary>
         bool ShouldSetSeparatePullRequestStatusForEachIssueProviderAndRun { get; set; }

diff --git a/...ues.Recipe/Cake.Frosting.Issues.Recipe/PullRequestSystems/AzureDevOpsPullRequestSystem.cs b/...ues.Recipe/Cake.Frosting.Issues.Recipe/PullRequestSystems/AzureDevOpsPullRequestSystem.cs
@@ -46,6 +46,16 @@ public override void SetPullRequestIssuesState(IIssuesContext context)
                 return;
             }
 
+            // Set status across all issues
+            if (context.Parameters.PullRequestSystem.ShouldSetPullRequestStatus)
+            {
+                SetPullRequestStatus(
+                    context,
+                    context.State.Issues,
+                    null);
+            }
+
+            // Set status for individual issue providers
             if (context.Parameters.PullRequestSystem.ShouldSetSeparatePullRequestStatusForEachIssueProviderAndRun)
             {
                 foreach (var providerGroup in context.State.Issues.GroupBy(x => x.ProviderType))
@@ -65,13 +75,6 @@ public override void SetPullRequestIssuesState(IIssuesContext context)
                     }
                 }
             }
-            else
-            {
-                SetPullRequestStatus(
-                    context,
-                    context.State.Issues,
-                    null);
-            }
         }
 
         /// <inheritdoc />

diff --git a/Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/SetPullRequestIssuesStateTask.cs b/Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/SetPullRequestIssuesStateTask.cs
@@ -18,7 +18,8 @@ public override bool ShouldRun(IIssuesContext context)
 
             return
                 !context.BuildSystem().IsLocalBuild &&
-                context.Parameters.PullRequestSystem.ShouldSetPullRequestStatus &&
+                (context.Parameters.PullRequestSystem.ShouldSetPullRequestStatus ||
+                context.Parameters.PullRequestSystem.ShouldSetSeparatePullRequestStatusForEachIssueProviderAndRun) &&
                 context.State.BuildServer != null && context.State.BuildServer.DetermineIfPullRequest(context);
         }
 

diff --git a/Cake.Issues.Recipe/Content/build.cake b/Cake.Issues.Recipe/Content/build.cake
@@ -232,7 +232,9 @@ IssuesBuildTasks.ReportIssuesToPullRequestTask = Task("Report-IssuesToPullReques
 IssuesBuildTasks.SetPullRequestIssuesStateTask = Task("Set-PullRequestIssuesState")
     .Description("Set pull request status.")
     .WithCriteria(() => !BuildSystem.IsLocalBuild, "Not running on build server")
-    .WithCriteria(() => IssuesParameters.PullRequestSystem.ShouldSetPullRequestStatus, "Setting of pull request status is disabled")
+    .WithCriteria(() => 
+        IssuesParameters.PullRequestSystem.ShouldSetPullRequestStatus || IssuesParameters.PullRequestSystem.ShouldSetSeparatePullRequestStatusForEachIssueProviderAndRun,
+        "Setting of pull request status is disabled")
     .WithCriteria<IssuesData>((context, data) => data.BuildServer != null ? data.BuildServer.DetermineIfPullRequest(context) : false, "Not a pull request build")
     .IsDependentOn("Read-Issues")
     .Does<IssuesData>((data) =>

diff --git a/Cake.Issues.Recipe/Content/parameters/IssuesParametersPullRequestSystem.cake b/Cake.Issues.Recipe/Content/parameters/IssuesParametersPullRequestSystem.cake
@@ -47,14 +47,15 @@ public class IssuesParametersPullRequestSystem
     /// </summary>
     public Dictionary<string, IProviderIssueLimits> ProviderIssueLimits { get; } = new Dictionary<string, IProviderIssueLimits>();
 
-    /// <summary>
-    /// Gets or sets a value indicating whether a status on the pull request should be set.
+    /// Gets or sets a value indicating whether a status on the pull request should be set if there are any issues found.
+    /// The status is succeeded if there are no issues and fails as soon as issues from any issue provider or run have been found.
+    /// Use <see cref="ShouldSetSeparatePullRequestStatusForEachIssueProviderAndRun"/> to report additional status for issues of every issue provider and run.
     /// Default value is <c>true</c>.
-    /// </summary>
     public bool ShouldSetPullRequestStatus { get; set; } = true;
 
     /// <summary>
     /// Gets or sets a value indicating whether a separate status should be set for issues of every issue provider and run.
+    /// Use <see cref="ShouldSetPullRequestStatus"/> to report status across all issue providers and runs.
     /// Default value is <c>false</c>.
     /// </summary>
     public bool ShouldSetSeparatePullRequestStatusForEachIssueProviderAndRun { get; set; }

diff --git a/Cake.Issues.Recipe/Content/tasks/pullrequestsystems/AzureDevOpsPullRequestSystem.cake b/Cake.Issues.Recipe/Content/tasks/pullrequestsystems/AzureDevOpsPullRequestSystem.cake
@@ -36,6 +36,17 @@ public class AzureDevOpsPullRequestSystem : BasePullRequestSystem
             return;
         }
 
+        // Set status across all issues
+        if (IssuesParameters.PullRequestSystem.ShouldSetPullRequestStatus)
+        {
+            SetPullRequestStatus(
+                context,
+                data,
+                data.Issues,
+                null);
+        }
+
+        // Set status for individual issue providers
         if (IssuesParameters.PullRequestSystem.ShouldSetSeparatePullRequestStatusForEachIssueProviderAndRun)
         {
             foreach (var providerGroup in data.Issues.GroupBy(x => x.ProviderType))
@@ -56,14 +67,6 @@ public class AzureDevOpsPullRequestSystem : BasePullRequestSystem
                 }
             }
         }
-        else
-        {
-            SetPullRequestStatus(
-                context,
-                data,
-                data.Issues,
-                null);
-        }
     }
 
     /// <inheritdoc />

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -71,7 +71,7 @@ By default [Cake.Git addin] will be used.
 | `IssuesParameters.PullRequestSystem.`<br/>&nbsp;&nbsp;&nbsp;&nbsp;`MaxIssuesToPostAcrossRuns`                                    | `IssuesContext.Parameters.PullRequestSystem.`<br/>&nbsp;&nbsp;&nbsp;&nbsp;`MaxIssuesToPostAcrossRuns`                                    | `null`        | Global number of issues which should be posted at maximum over all issue providers and across multiple runs. Issues are filtered by priority and issues with a file path are prioritized. `null` won't set a limit across multiple runs. |
 | `IssuesParameters.PullRequestSystem.`<br/>&nbsp;&nbsp;&nbsp;&nbsp;`MaxIssuesToPostForEachIssueProvider`                          | `IssuesContext.Parameters.PullRequestSystem.`<br/>&nbsp;&nbsp;&nbsp;&nbsp;`MaxIssuesToPostForEachIssueProvider`                          | `100`         | Number of issues which should be posted at maximum for each issue provider. Issues are filtered by priority and issues with a file path are prioritized. `null` won't limit issues per issue provider.                                   |
 | `IssuesParameters.PullRequestSystem.`<br/>&nbsp;&nbsp;&nbsp;&nbsp;`ProviderIssueLimits`                                          | `IssuesContext.Parameters.PullRequestSystem.`<br/>&nbsp;&nbsp;&nbsp;&nbsp;`ProviderIssueLimits`                                          | Empty         | Issue limits for individual issue provider. The key must be the `IIssue.ProviderType` of a specific provider to which the limits should be applied to.                                                                                   |
-| `IssuesParameters.PullRequestSystem.`<br/>&nbsp;&nbsp;&nbsp;&nbsp;`ShouldSetPullRequestStatus`                                   | `IssuesContext.Parameters.PullRequestSystem.`<br/>&nbsp;&nbsp;&nbsp;&nbsp;`ShouldSetPullRequestStatus`                                   | `true`        | Indicates whether a status on the pull request should be set.                                                                                                                                                                            |
+| `IssuesParameters.PullRequestSystem.`<br/>&nbsp;&nbsp;&nbsp;&nbsp;`ShouldSetPullRequestStatus`                                   | `IssuesContext.Parameters.PullRequestSystem.`<br/>&nbsp;&nbsp;&nbsp;&nbsp;`ShouldSetPullRequestStatus`                                   | `true`        | Indicates whether a status on the pull request should be set if there are any issues found.                                                                                                                                              |
 | `IssuesParameters.PullRequestSystem.`<br/>&nbsp;&nbsp;&nbsp;&nbsp;`ShouldSetSeparatePullRequestStatusForEachIssueProviderAndRun` | `IssuesContext.Parameters.PullRequestSystem.`<br/>&nbsp;&nbsp;&nbsp;&nbsp;`ShouldSetSeparatePullRequestStatusForEachIssueProviderAndRun` | `false`       | Indicates whether a separate status should be set for issues of every issue provider and run.                                                                                                                                            |
 
 [Cake.Git addin]: https://cakebuild.net/extensions/cake-git/