Update mergify config generator and config (#4654)

jackkoenig · web-flow · commit 1ac76764f2cf · 2025-01-29T16:24:35.000-08:00
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -45,5 +45,5 @@ Please be sure to elaborate on any API changes or deprecations and any impact on
 - [ ] Did you review?
 - [ ] Did you check whether all relevant Contributor checkboxes have been checked?
 - [ ] Did you do one of the following when ready to merge:
-  - [ ] Squash: You/ the contributor `Enable auto-merge (squash)`, clean up the commit message, and label with `Please Merge`.
+  - [ ] Squash: You/ the contributor `Enable auto-merge (squash)` and clean up the commit message.
   - [ ] Merge: Ensure that contributor has cleaned up their commit history, then merge with `Create a merge commit`.
diff --git a/.github/mergify/gen-config.sc b/.github/mergify/gen-config.sc
@@ -1,69 +1,56 @@
 #!/usr/bin/env -S scala-cli shebang
 // SPDX-License-Identifier: Apache-2.0
 //> using scala "2.13"
-//> using dep "io.circe::circe-yaml:0.15.1"
-//> using dep "com.lihaoyi::os-lib:0.9.1"
+//> using dep "io.circe::circe-yaml:0.16.0"
+//> using dep "com.lihaoyi::os-lib:0.11.3"
 
 /* Generates a Mergify config YAML (to STDOUT) based on input config
  *
  * There are built-in conditions, but different CI requires different conditions
  * Listed branches should be stable branches that we want to backport to, in ascending order
- * {{{
+ *
  * conditions:
-     - status-success=Travis CI - Pull Request
+     - status-success=all tests passed
    branches:
-     - 1.2.x
-     - 1.3.x
-     - 1.4.x
- * }}}
+     - 3.6.x
+     - 5.x
+     - 6.x
+ *
  */
 
 import io.circe._
 import io.circe.syntax._ // for .asJson
 import io.circe.yaml.parser
 import io.circe.yaml.syntax._ // for .asYaml
 
-def mergeQueue(conditions: List[String]) = Json.obj(
-  "name" -> "default".asJson,
-  "conditions" -> conditions.asJson,
-  "draft_bot_account" -> "chiselbot".asJson,
-  "update_bot_account" -> "chiselbot".asJson,
-  "merge_bot_account" -> "chiselbot".asJson
-)
-
-val queueAction = Json.obj(
-  "queue" -> Json.obj(
-    "name" -> "default".asJson,
-    "method" -> "squash".asJson,
-    "update_method" -> "merge".asJson,
-    "update_bot_account" -> "chiselbot".asJson,
-    "merge_bot_account" -> "chiselbot".asJson
-  )
-)
-
-def mergeToMain(conditions: List[String]) = Json.obj(
-  "name" -> "automatic squash-and-merge on CI success and review".asJson,
-  "conditions" -> (conditions ++ List(
-    "#approved-reviews-by>=1",
+def mergeQueue(branch: String, conditions: List[String]) = Json.obj(
+  "name" -> s"$branch merge queue".asJson,
+  "queue_conditions" -> (conditions ++ List(
+    s"base=$branch",
     "#changes-requested-reviews-by=0",
-    "base=main",
-    "label=\"Please Merge\"",
+    "label=\"Backport\"",
     "label!=\"DO NOT MERGE\"",
     "label!=\"bp-conflict\""
   )).asJson,
-  "actions" -> queueAction
+  "merge_conditions" -> conditions.asJson,
+  "draft_bot_account" -> "chiselbot".asJson,
+  "update_bot_account" -> "chiselbot".asJson,
+  "merge_bot_account" -> "chiselbot".asJson
 )
 
 def makeBackportRule(branches: List[String]): Json = {
   Json.obj(
     "name" -> s"""backport to ${branches.mkString(", ")}""".asJson,
-    "conditions" -> List("merged", "base=main", s"milestone=${branches.head}").asJson,
+    "conditions" -> List("merged", s"milestone=${branches.head}").asJson,
     "actions" -> Json.obj(
       "backport" -> Json.obj(
         "branches" -> branches.asJson,
         "labels" -> List("Backport").asJson,
         "ignore_conflicts" -> true.asJson,
-        "label_conflicts" -> "bp-conflict".asJson
+        "merge_conflict_style" -> "diff3".asJson,
+        "label_conflicts" -> "bp-conflict".asJson,
+        "bot_account" -> "chiselbot".asJson,
+        "report_mode" -> List("comment").asJson
       ),
       "label" -> Json.obj(
         "add" -> List("Backported").asJson
@@ -73,34 +60,40 @@ def makeBackportRule(branches: List[String]): Json = {
 }
 
 def backportMergeRule(conditions: List[String])(branch: String): Json = Json.obj(
-  "name" -> s"automatic squash-and-mege of $branch backport PRs".asJson,
+  "name" -> s"queue $branch backport PRs".asJson,
   "conditions" -> (conditions ++ List(
     "#changes-requested-reviews-by=0",
     s"base=$branch",
     "label=\"Backport\"",
     "label!=\"DO NOT MERGE\"",
     "label!=\"bp-conflict\""
   )).asJson,
-  "actions" -> queueAction
+  "actions" -> Json.obj(
+    "queue" -> Json.obj(
+      "name" -> s"$branch merge queue".asJson
+    )
+  )
 )
 
-
 def error(msg: String) = throw new Exception(msg) with scala.util.control.NoStackTrace
 
 def processTemplate(path: os.Path): (List[String], List[String]) = {
   val contents = os.read(path)
-  val parsed = parser.parse(contents)
-                     .getOrElse(error(s"Invalid YAML $path"))
+  val parsed = parser
+    .parse(contents)
+    .getOrElse(error(s"Invalid YAML $path"))
 
   val cursor: HCursor = parsed.hcursor
 
-  val conditions = cursor.downField("conditions")
-                         .as[List[String]]
-                         .getOrElse(error(s"Invalid template, expected field 'conditions': List[String]"))
+  val conditions = cursor
+    .downField("conditions")
+    .as[List[String]]
+    .getOrElse(error(s"Invalid template, expected field 'conditions': List[String]"))
 
-  val branches = cursor.downField("branches")
-                       .as[List[String]]
-                       .getOrElse(error(s"Invalid template, expected field 'branches': List[String]"))
+  val branches = cursor
+    .downField("branches")
+    .as[List[String]]
+    .getOrElse(error(s"Invalid template, expected field 'branches': List[String]"))
   (conditions, branches)
 }
 
@@ -112,15 +105,13 @@ val (conditions, branches) = processTemplate(template)
 val branchSets = branches.scanRight(List.empty[String])(_ :: _).init.reverse
 
 val config = Json.obj(
-	"queue_rules" -> Json.fromValues(
-		mergeQueue(conditions) ::
-		Nil
-	),
-	"pull_request_rules" -> Json.fromValues(
-		mergeToMain(conditions) ::
-		branchSets.map(makeBackportRule) :::
-		branches.map(backportMergeRule(conditions))
-	)
+  "queue_rules" -> Json.fromValues(
+    branches.map(mergeQueue(_, conditions))
+  ),
+  "pull_request_rules" -> Json.fromValues(
+    branchSets.map(makeBackportRule) :::
+      branches.map(backportMergeRule(conditions))
+  )
 )
 
 println(s"# Generated by $scriptPath")
diff --git a/.mergify.yml b/.mergify.yml
@@ -1,32 +1,48 @@
 # Generated by .github/mergify/gen-config.sc
 queue_rules:
-- name: default
-  conditions:
+- name: 3.6.x merge queue
+  queue_conditions:
+  - status-success=all tests passed
+  - base=3.6.x
+  - '#changes-requested-reviews-by=0'
+  - label="Backport"
+  - label!="DO NOT MERGE"
+  - label!="bp-conflict"
+  merge_conditions:
   - status-success=all tests passed
   draft_bot_account: chiselbot
   update_bot_account: chiselbot
   merge_bot_account: chiselbot
-pull_request_rules:
-- name: automatic squash-and-merge on CI success and review
-  conditions:
+- name: 5.x merge queue
+  queue_conditions:
   - status-success=all tests passed
-  - '#approved-reviews-by>=1'
+  - base=5.x
   - '#changes-requested-reviews-by=0'
-  - base=main
-  - label="Please Merge"
+  - label="Backport"
   - label!="DO NOT MERGE"
   - label!="bp-conflict"
-  actions:
-    queue:
-      name: default
-      method: squash
-      update_method: merge
-      update_bot_account: chiselbot
-      merge_bot_account: chiselbot
+  merge_conditions:
+  - status-success=all tests passed
+  draft_bot_account: chiselbot
+  update_bot_account: chiselbot
+  merge_bot_account: chiselbot
+- name: 6.x merge queue
+  queue_conditions:
+  - status-success=all tests passed
+  - base=6.x
+  - '#changes-requested-reviews-by=0'
+  - label="Backport"
+  - label!="DO NOT MERGE"
+  - label!="bp-conflict"
+  merge_conditions:
+  - status-success=all tests passed
+  draft_bot_account: chiselbot
+  update_bot_account: chiselbot
+  merge_bot_account: chiselbot
+pull_request_rules:
 - name: backport to 6.x
   conditions:
   - merged
-  - base=main
   - milestone=6.x
   actions:
     backport:
@@ -35,14 +51,17 @@ pull_request_rules:
       labels:
       - Backport
       ignore_conflicts: true
+      merge_conflict_style: diff3
       label_conflicts: bp-conflict
+      bot_account: chiselbot
+      report_mode:
+      - comment
     label:
       add:
       - Backported
 - name: backport to 5.x, 6.x
   conditions:
   - merged
-  - base=main
   - milestone=5.x
   actions:
     backport:
@@ -52,14 +71,17 @@ pull_request_rules:
       labels:
       - Backport
       ignore_conflicts: true
+      merge_conflict_style: diff3
       label_conflicts: bp-conflict
+      bot_account: chiselbot
+      report_mode:
+      - comment
     label:
       add:
       - Backported
 - name: backport to 3.6.x, 5.x, 6.x
   conditions:
   - merged
-  - base=main
   - milestone=3.6.x
   actions:
     backport:
@@ -70,11 +92,15 @@ pull_request_rules:
       labels:
       - Backport
       ignore_conflicts: true
+      merge_conflict_style: diff3
       label_conflicts: bp-conflict
+      bot_account: chiselbot
+      report_mode:
+      - comment
     label:
       add:
       - Backported
-- name: automatic squash-and-mege of 3.6.x backport PRs
+- name: queue 3.6.x backport PRs
   conditions:
   - status-success=all tests passed
   - '#changes-requested-reviews-by=0'
@@ -84,12 +110,8 @@ pull_request_rules:
   - label!="bp-conflict"
   actions:
     queue:
-      name: default
-      method: squash
-      update_method: merge
-      update_bot_account: chiselbot
-      merge_bot_account: chiselbot
-- name: automatic squash-and-mege of 5.x backport PRs
+      name: 3.6.x merge queue
+- name: queue 5.x backport PRs
   conditions:
   - status-success=all tests passed
   - '#changes-requested-reviews-by=0'
@@ -99,12 +121,8 @@ pull_request_rules:
   - label!="bp-conflict"
   actions:
     queue:
-      name: default
-      method: squash
-      update_method: merge
-      update_bot_account: chiselbot
-      merge_bot_account: chiselbot
-- name: automatic squash-and-mege of 6.x backport PRs
+      name: 5.x merge queue
+- name: queue 6.x backport PRs
   conditions:
   - status-success=all tests passed
   - '#changes-requested-reviews-by=0'
@@ -114,9 +132,5 @@ pull_request_rules:
   - label!="bp-conflict"
   actions:
     queue:
-      name: default
-      method: squash
-      update_method: merge
-      update_bot_account: chiselbot
-      merge_bot_account: chiselbot
+      name: 6.x merge queue
 
