projen · Chriscbr · Apr 13, 2022 · Apr 13, 2022 · Apr 14, 2022 · Apr 15, 2022
diff --git a/.gitignore b/.gitignore
diff --git a/.projenrc.js b/.projenrc.js
@@ -147,7 +147,7 @@ project.vscode.launchConfiguration.addConfiguration({
   outFiles: ["${workspaceFolder}/lib/**/*.js"],
 });
 
-project.github.mergify.addRule({
+project.autoMerge.mergify.addRule({
   name: "Label core contributions",
   actions: {
     label: {

diff --git a/docs/api/API.md b/docs/api/API.md
diff --git a/docs/github.md b/docs/github.md
@@ -40,6 +40,19 @@ const project = new javascript.NodeProject({
 });
 ```
 
+## Automatic Merging
+
+Automatic merging can be configured through the `autoMerge` and
+`autoMergeOptions` fields on most default projects, or by directly creating an
+`AutoMerge` component in your project. Currently this uses
+[Mergify](https://mergify.com/), and expects it to be installed on your GitHub
+repository for it to work. (Stay tuned for more ways of supporting auto
+merging!)
+
+To access the underlying `Mergify` configuration, you can use
+`project.autoMerge.mergify`. See `AutoMerge` and `Mergify` in the API reference
+for a full list of available options and methods.
+
 ## Workflows
 
 TODO

diff --git a/src/github/auto-merge.ts b/src/github/auto-merge.ts
@@ -1,5 +1,6 @@
 import { Component } from "../component";
 import { GitHub } from "./github";
+import { Mergify } from "./mergify";
 
 export interface AutoMergeOptions {
   /**
@@ -18,22 +19,21 @@ export interface AutoMergeOptions {
 /**
  * Sets up mergify to merging approved pull requests.
  *
- * If `buildJob` is specified, the specified GitHub workflow job ID is required
- * to succeed in order for the PR to be merged.
- *
  * `approvedReviews` specified the number of code review approvals required for
  * the PR to be merged.
  */
 export class AutoMerge extends Component {
+  /**
+   * Mergify configuration for this project.
+   */
+  public readonly mergify: Mergify;
+
   private readonly lazyConditions = new Array<IAddConditionsLater>();
 
   constructor(github: GitHub, options: AutoMergeOptions = {}) {
     super(github.project);
 
-    const mergify = github.mergify;
-    if (!mergify) {
-      throw new Error("auto merging requires mergify to be enabled");
-    }
+    this.mergify = new Mergify(github);
 
     const blockingLabels = options.blockingLabels ?? ["do-not-merge"];
     const blockingCondition = blockingLabels?.length
@@ -63,18 +63,16 @@ export class AutoMerge extends Component {
     this.addConditions(`#approved-reviews-by>=${approvedReviews}`);
     this.addConditions(...blockingCondition);
 
-    mergify.addRule({
+    this.mergify.addRule({
       name: "Automatic merge on approval and successful build",
       actions: mergeAction,
       conditions: (() => this.renderConditions()) as any,
     });
 
-    mergify.addQueue({
+    this.mergify.addQueue({
       name: "default",
       conditions: (() => this.renderConditions()) as any,
     });
-
-    this.project.addPackageIgnore("/.mergify.yml");
   }
 
   /**

diff --git a/src/github/github-project.ts b/src/github/github-project.ts
@@ -4,10 +4,9 @@ import { Project, ProjectOptions, ProjectType } from "../project";
 import { SampleReadme, SampleReadmeProps } from "../readme";
 import { DevContainer, VsCode } from "../vscode";
 import { AutoApprove, AutoApproveOptions } from "./auto-approve";
-import { AutoMergeOptions } from "./auto-merge";
+import { AutoMerge, AutoMergeOptions } from "./auto-merge";
 import { GitHub, GitHubOptions } from "./github";
 import { GithubCredentials } from "./github-credentials";
-import { MergifyOptions } from "./mergify";
 import { Stale, StaleOptions } from "./stale";
 
 /**
@@ -46,22 +45,6 @@ export interface GitHubProjectOptions extends ProjectOptions {
    */
   readonly githubOptions?: GitHubOptions;
 
-  /**
-   * Whether mergify should be enabled on this repository or not.
-   *
-   * @default true
-   * @deprecated use `githubOptions.mergify` instead
-   */
-  readonly mergify?: boolean;
-
-  /**
-   * Options for mergify
-   *
-   * @default - default options
-   * @deprecated use `githubOptions.mergifyOptions` instead
-   */
-  readonly mergifyOptions?: MergifyOptions;
-
   /**
    * Add a VSCode development environment (used for GitHub Codespaces)
    *
@@ -97,8 +80,17 @@ export interface GitHubProjectOptions extends ProjectOptions {
   readonly autoApproveOptions?: AutoApproveOptions;
 
   /**
-   * Configure options for automatic merging on GitHub. Has no effect if
-   * `github.mergify` is set to false.
+   * Enable automatic merging pull requests on GitHub. Currently, this only
+   * supports using Mergify to merge pull requests. Has no effect if `github` is
+   * set to false.
+   *
+   * @default true
+   */
+  readonly autoMerge?: boolean;
+
+  /**
+   * Configure options for automatic merging pull requests on GitHub. Has no
+   * effect if `autoMerge` is set to false or `github` is set to false.
    *
    * @default - see defaults in `AutoMergeOptions`
    */
@@ -181,6 +173,11 @@ export class GitHubProject extends Project {
    */
   public readonly projectType: ProjectType;
 
+  /**
+   * Auto merging pull requests for this project.
+   */
+  public readonly autoMerge?: AutoMerge;
+
   /**
    * Auto approve set up for this project.
    */
@@ -196,8 +193,6 @@ export class GitHubProject extends Project {
       ? new GitHub(this, {
           projenTokenSecret: options.projenTokenSecret,
           projenCredentials: options.projenCredentials,
-          mergify: options.mergify,
-          mergifyOptions: options.mergifyOptions,
           ...options.githubOptions,
         })
       : undefined;
@@ -223,6 +218,11 @@ export class GitHubProject extends Project {
       );
     }
 
+    const autoMerge = options.autoMerge ?? true;
+    if (autoMerge && this.github) {
+      this.autoMerge = new AutoMerge(this.github, options.autoMergeOptions);
+    }
+
     const stale = options.stale ?? false;
     if (stale && this.github) {
       new Stale(this.github, options.staleOptions);

diff --git a/src/github/github.ts b/src/github/github.ts
@@ -2,26 +2,11 @@ import { Component } from "../component";
 import { Project } from "../project";
 import { Dependabot, DependabotOptions } from "./dependabot";
 import { GithubCredentials } from "./github-credentials";
-import { Mergify, MergifyOptions } from "./mergify";
 import { PullRequestTemplate } from "./pr-template";
 import { PullRequestLint, PullRequestLintOptions } from "./pull-request-lint";
 import { GithubWorkflow } from "./workflows";
 
 export interface GitHubOptions {
-  /**
-   * Whether mergify should be enabled on this repository or not.
-   *
-   * @default true
-   */
-  readonly mergify?: boolean;
-
-  /**
-   * Options for Mergify.
-   *
-   * @default - default options
-   */
-  readonly mergifyOptions?: MergifyOptions;
-
   /**
    * Enables GitHub workflows. If this is set to `false`, workflows will not be created.
    *
@@ -72,12 +57,6 @@ export class GitHub extends Component {
     return project.components.find(isGitHub);
   }
 
-  /**
-   * The `Mergify` configured on this repository. This is `undefined` if Mergify
-   * was not enabled when creating the repository.
-   */
-  public readonly mergify?: Mergify;
-
   /**
    * Are workflows enabled?
    */
@@ -111,10 +90,6 @@ export class GitHub extends Component {
       });
     }
 
-    if (options.mergify ?? true) {
-      this.mergify = new Mergify(this, options.mergifyOptions);
-    }
-
     if (options.pullRequestLint ?? true) {
       new PullRequestLint(this, options.pullRequestLintOptions);
     }

diff --git a/src/javascript/node-project.ts b/src/javascript/node-project.ts
@@ -603,13 +603,17 @@ export class NodeProject extends GitHubProject {
       }
     }
 
-    if (this.github?.mergify && this.buildWorkflow?.buildJobIds) {
-      this.autoMerge = new AutoMerge(this.github, options.autoMergeOptions);
-      this.autoMerge.addConditionsLater({
-        render: () =>
-          this.buildWorkflow?.buildJobIds.map((id) => `status-success=${id}`) ??
-          [],
-      });
+    if (this.autoMerge) {
+      this.addPackageIgnore("/.mergify.yml");
+
+      if (this.buildWorkflow?.buildJobIds) {
+        this.autoMerge.addConditionsLater({
+          render: () =>
+            this.buildWorkflow?.buildJobIds.map(
+              (id) => `status-success=${id}`
+            ) ?? [],
+        });
+      }
     }
 
     const dependabot = options.dependabot ?? false;

diff --git a/test/__snapshots__/cleanup.test.ts.snap b/test/__snapshots__/cleanup.test.ts.snap