Improve darc UX around merge policy definition (#4446)

- It was not possible to set the `ValidateCoherency` policy manually - The help text contains better examples on how to define the policies dotnet/sdk#46716 (comment)
dotnet · Feb 12, 2025 · 8aa3faf · 8aa3faf
1 parent 85ca22a
commit 8aa3faf
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 12 deletions.
diff --git a/src/Microsoft.DotNet.Darc/Darc/Constants.cs b/src/Microsoft.DotNet.Darc/Darc/Constants.cs
@@ -45,20 +45,30 @@ public class Constants
         "Each policy may have a set of required properties." +
         "See below for available merge policies:",
         "",
-        $"{MergePolicyConstants.StandardMergePolicyName} - Corresponds to either StandardGitHub or StandardAzureDevOps depending on the target repo type",
-        "The standard github merge policy is:",
-        $"- {MergePolicyConstants.AllCheckSuccessfulMergePolicyName} with the 'WIP' and 'license/cla' checks ignored.",
-        $"- {MergePolicyConstants.NoRequestedChangesMergePolicyName}",
-        $"- {MergePolicyConstants.DontAutomergeDowngradesPolicyName}",
-        $"- {MergePolicyConstants.ValidateCoherencyMergePolicyName}",
+        $"- Name: {MergePolicyConstants.StandardMergePolicyName} - Corresponds to either standard GitHub or AzureDevOps depending on the target repo type",
+        "The standard GitHub merge policy is:",
+        $"- Name: {MergePolicyConstants.AllCheckSuccessfulMergePolicyName}",
+        $"  Properties:",
+        $"    ignoreCheckes:",
+        $"    - WIP",
+        $"    - license/cla",
+        $"- Name: {MergePolicyConstants.NoRequestedChangesMergePolicyName}",
+        $"- Name: {MergePolicyConstants.DontAutomergeDowngradesPolicyName}",
+        $"- Name: {MergePolicyConstants.ValidateCoherencyMergePolicyName}",
         "The standard Azure DevOps merge policy is:",
-        $"- {MergePolicyConstants.AllCheckSuccessfulMergePolicyName} with the 'Comment requirements', 'Minimum number of reviewers', 'Required reviewers',",
-        "  and 'Work item linking' checks ignored.",
-        $"- {MergePolicyConstants.NoRequestedChangesMergePolicyName}",
-        $"- {MergePolicyConstants.DontAutomergeDowngradesPolicyName}",
+        $"- Name: {MergePolicyConstants.AllCheckSuccessfulMergePolicyName}",
+        $"  Properties:",
+        $"    ignoreCheckes:",
+        $"    - Comment requirements",
+        $"    - Minimum number of reviewers",
+        $"    - Required reviewers",
+        $"    - Work item linking",
+        $"- Name: {MergePolicyConstants.NoRequestedChangesMergePolicyName}",
+        $"- Name: {MergePolicyConstants.DontAutomergeDowngradesPolicyName}",
         "YAML format:",
         $"- Name: {MergePolicyConstants.StandardMergePolicyName}",
         "",
+        "Explanation for every check:",
         $"{MergePolicyConstants.AllCheckSuccessfulMergePolicyName} - All PR checks must be successful, potentially ignoring a specified set of checks.",
         "Checks might be ignored if they are unrelated to PR validation. The check name corresponds to the string that shows up",
         "in GitHub/Azure DevOps.",
@@ -81,6 +91,5 @@ public class Constants
         $"{MergePolicyConstants.ValidateCoherencyMergePolicyName} - If coherency check failed for the PR, it will not be merged.",
         "YAML format:",
         $"- Name: {MergePolicyConstants.ValidateCoherencyMergePolicyName}",
-
     ];
 }
diff --git a/src/Microsoft.DotNet.Darc/Darc/Models/PopUps/MergePoliciesPopUpHelpers.cs b/src/Microsoft.DotNet.Darc/Darc/Models/PopUps/MergePoliciesPopUpHelpers.cs
@@ -37,7 +37,8 @@ public static bool ValidateMergePolicies(List<MergePolicy> mergePolicies, ILogge
                 }
                 else if (policy.Name.Equals(MergePolicyConstants.StandardMergePolicyName, StringComparison.OrdinalIgnoreCase) ||
                          policy.Name.Equals(MergePolicyConstants.NoRequestedChangesMergePolicyName, StringComparison.OrdinalIgnoreCase) ||
-                         policy.Name.Equals(MergePolicyConstants.DontAutomergeDowngradesPolicyName, StringComparison.OrdinalIgnoreCase))
+                         policy.Name.Equals(MergePolicyConstants.DontAutomergeDowngradesPolicyName, StringComparison.OrdinalIgnoreCase) ||
+                         policy.Name.Equals(MergePolicyConstants.ValidateCoherencyMergePolicyName, StringComparison.OrdinalIgnoreCase))
                 {
                     // All good
                 }