fix: cannot disable automerge and while keeping mergify enabled (#1783)

Supersedes #1766 Fixes #1765 --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
projen · Apr 21, 2022 · a64180a · a64180a
1 parent 171a0eb
commit a64180a
Show file tree

Hide file tree

Showing 6 changed files with 394 additions and 6 deletions.
diff --git a/docs/api/API.md b/docs/api/API.md
diff --git a/src/github/github-project.ts b/src/github/github-project.ts
@@ -96,9 +96,16 @@ export interface GitHubProjectOptions extends ProjectOptions {
    */
   readonly autoApproveOptions?: AutoApproveOptions;
 
+  /**
+   * Enable automatic merging on GitHub. Has no effect if `github.mergify`
+   * is set to false.
+   * @default true
+   */
+  readonly autoMerge?: boolean;
+
   /**
    * Configure options for automatic merging on GitHub. Has no effect if
-   * `github.mergify` is set to false.
+   * `github.mergify` or `autoMerge` is set to false.
    *
    * @default - see defaults in `AutoMergeOptions`
    */

diff --git a/src/javascript/node-project.ts b/src/javascript/node-project.ts
@@ -338,7 +338,7 @@ export class NodeProject extends GitHubProject {
   }
 
   /**
-   * Automatic PR merges.
+   * Component that sets up mergify for merging approved pull requests.
    */
   public readonly autoMerge?: AutoMerge;
 
@@ -603,7 +603,11 @@ export class NodeProject extends GitHubProject {
       }
     }
 
-    if (this.github?.mergify && this.buildWorkflow?.buildJobIds) {
+    if (
+      (options.autoMerge ?? true) &&
+      this.github?.mergify &&
+      this.buildWorkflow?.buildJobIds
+    ) {
       this.autoMerge = new AutoMerge(this.github, options.autoMergeOptions);
       this.autoMerge.addConditionsLater({
         render: () =>