@salesforce/plugin-release-management 3.15.9 → 3.16.0

package/lib/commands/cli/release/automerge.d.ts

@@ -0,0 +1,19 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export default class AutoMerge extends SfCommand<void> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        owner: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        repo: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'pull-number': import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'dry-run': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        verbose: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    private octokit;
+    private baseRepoParams;
+    private pullRequestParams;
+    run(): Promise<void>;
+    private isGreen;
+    private isMergeable;
+}

package/lib/commands/cli/release/automerge.js

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, camelcase*/
+const sf_plugins_core_1 = require("@salesforce/sf-plugins-core");
+const core_1 = require("@octokit/core");
+const kit_1 = require("@salesforce/kit");
+const ts_types_1 = require("@salesforce/ts-types");
+const core_2 = require("@salesforce/core");
+core_2.Messages.importMessagesDirectory(__dirname);
+const messages = core_2.Messages.loadMessages('@salesforce/plugin-release-management', 'cli.release.automerge');
+class AutoMerge extends sf_plugins_core_1.SfCommand {
+    async run() {
+        const { flags } = await this.parse(AutoMerge);
+        const { 'dry-run': dryRun, owner, repo, verbose, 'pull-number': pullNumber } = flags;
+        const auth = (0, ts_types_1.ensureString)(new kit_1.Env().getString('GH_TOKEN') ?? new kit_1.Env().getString('GITHUB_TOKEN'), 'GH_TOKEN is required to be set in the environment');
+        this.octokit = new core_1.Octokit({ auth });
+        this.baseRepoParams = { owner, repo };
+        this.pullRequestParams = {
+            ...this.baseRepoParams,
+            pull_number: pullNumber,
+        };
+        const prData = (await this.octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}', { ...this.pullRequestParams })).data;
+        // Check if PR is able to be merged.
+        const stop = (reason) => {
+            if (verbose)
+                this.styledJSON(prData);
+            throw new core_2.SfError(`CANNOT MERGE: ${reason}`, 'AUTOMERGE_FAILURE', [
+                'Run with --verbose to see PR response object',
+            ]);
+        };
+        if (prData.state !== 'open') {
+            stop('PR not open');
+        }
+        const automergeLabels = ['automerge', 'nightly-automerge'];
+        if (!prData.labels.some((label) => automergeLabels.includes(label.name))) {
+            stop(`Missing automerge label: [${automergeLabels.join(', ')}]`);
+        }
+        if (prData.user.login !== 'svc-cli-bot') {
+            stop('PR must be created by "svc-cli-bot"');
+        }
+        if (!(await this.isGreen(prData))) {
+            stop('PR checks failed');
+        }
+        if (!(await this.isMergeable())) {
+            stop('PR is not mergable');
+        }
+        // Continue with merge attempt
+        if (dryRun === false) {
+            this.log(`Merging ${prData.number} | ${prData.title}`);
+            const mergeResult = await this.octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge', {
+                ...this.pullRequestParams,
+            });
+            this.info('Run with --verbose to see PR merge response');
+            if (verbose) {
+                this.styledJSON(mergeResult);
+            }
+        }
+        else {
+            this.logSuccess(`Dry run successful: ${prData.number} | ${prData.title}`);
+        }
+    }
+    async isGreen(pr) {
+        const statusResponse = await this.octokit.request('GET /repos/{owner}/{repo}/commits/{ref}/status', {
+            ...this.baseRepoParams,
+            ref: pr.head.sha,
+        });
+        // no point looking at check runs if the commit status is not green
+        if (statusResponse.data.state !== 'success') {
+            return false;
+        }
+        const checkRunResponse = await this.octokit.request('GET /repos/{owner}/{repo}/commits/{ref}/check-runs', {
+            ...this.baseRepoParams,
+            ref: pr.head.sha,
+        });
+        if (checkRunResponse.data.check_runs.every((cr) => cr.status === 'completed' && ['success', 'skipped'].includes(cr.conclusion))) {
+            return true;
+        }
+    }
+    async isMergeable() {
+        const statusResponse = await this.octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}', {
+            ...this.pullRequestParams,
+        });
+        // mergeable_state of 'blocked' is ok because it is either missing an approval or the commit is not signed.
+        // We're screening out 'behind' which might be merge conflicts.
+        if (statusResponse.data.mergeable === true && statusResponse.data.mergeable_state !== 'behind') {
+            return true;
+        }
+    }
+}
+exports.default = AutoMerge;
+AutoMerge.summary = messages.getMessage('description');
+AutoMerge.description = messages.getMessage('description');
+AutoMerge.examples = messages.getMessages('examples');
+AutoMerge.flags = {
+    owner: sf_plugins_core_1.Flags.string({
+        summary: messages.getMessage('owner'),
+        dependsOn: ['repo'],
+        aliases: ['org'],
+        required: true,
+    }),
+    repo: sf_plugins_core_1.Flags.string({
+        summary: messages.getMessage('repo'),
+        dependsOn: ['owner'],
+        required: true,
+    }),
+    'pull-number': sf_plugins_core_1.Flags.integer({
+        summary: messages.getMessage('pull-number'),
+        required: true,
+    }),
+    'dry-run': sf_plugins_core_1.Flags.boolean({
+        summary: messages.getMessage('dry-run'),
+        char: 'd',
+        default: false,
+    }),
+    verbose: sf_plugins_core_1.Flags.boolean({
+        summary: messages.getMessage('verbose'),
+        default: false,
+    }),
+};
+//# sourceMappingURL=automerge.js.map

package/lib/commands/cli/release/automerge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"automerge.js","sourceRoot":"","sources":["../../../../src/commands/cli/release/automerge.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,qJAAqJ;AACrJ,iEAA+D;AAC/D,wCAAwC;AACxC,yCAAsC;AACtC,mDAAoD;AACpD,2CAAqD;AAErD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAE5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,uCAAuC,EAAE,uBAAuB,CAAC,CAAC;AASzG,MAAqB,SAAU,SAAQ,2BAAe;IAoC7C,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAE9C,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;QAErF,MAAM,IAAI,GAAG,IAAA,uBAAY,EACvB,IAAI,SAAG,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,IAAI,SAAG,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,EACtE,mDAAmD,CACpD,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG,IAAI,cAAO,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QAErC,IAAI,CAAC,cAAc,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAEtC,IAAI,CAAC,iBAAiB,GAAG;YACvB,GAAG,IAAI,CAAC,cAAc;YACtB,WAAW,EAAE,UAAU;SACxB,CAAC;QAEF,MAAM,MAAM,GAAG,CACb,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,+CAA+C,EAAE,EAAE,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAC3G,CAAC,IAAI,CAAC;QAEP,oCAAoC;QACpC,MAAM,IAAI,GAAG,CAAC,MAAc,EAAQ,EAAE;YACpC,IAAI,OAAO;gBAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YACrC,MAAM,IAAI,cAAO,CAAC,iBAAiB,MAAM,EAAE,EAAE,mBAAmB,EAAE;gBAChE,8CAA8C;aAC/C,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,IAAI,MAAM,CAAC,KAAK,KAAK,MAAM,EAAE;YAC3B,IAAI,CAAC,aAAa,CAAC,CAAC;SACrB;QAED,MAAM,eAAe,GAAG,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;QAC3D,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE;YACxE,IAAI,CAAC,6BAA6B,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAClE;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,aAAa,EAAE;YACvC,IAAI,CAAC,qCAAqC,CAAC,CAAC;SAC7C;QAED,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE;YACjC,IAAI,CAAC,kBAAkB,CAAC,CAAC;SAC1B;QAED,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE;YAC/B,IAAI,CAAC,oBAAoB,CAAC,CAAC;SAC5B;QAED,8BAA8B;QAC9B,IAAI,MAAM,KAAK,KAAK,EAAE;YACpB,IAAI,CAAC,GAAG,CAAC,WAAW,MAAM,CAAC,MAAM,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;YAEvD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,qDAAqD,EAAE;gBACpG,GAAG,IAAI,CAAC,iBAAiB;aAC1B,CAAC,CAAC;YAEH,IAAI,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;YACzD,IAAI,OAAO,EAAE;gBACX,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;aAC9B;SACF;aAAM;YACL,IAAI,CAAC,UAAU,CAAC,uBAAuB,MAAM,CAAC,MAAM,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;SAC3E;IACH,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,EAAE;QACtB,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,gDAAgD,EAAE;YAClG,GAAG,IAAI,CAAC,cAAc;YACtB,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG;SACjB,CAAC,CAAC;QACH,mEAAmE;QACnE,IAAI,cAAc,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;YAC3C,OAAO,KAAK,CAAC;SACd;QAED,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,oDAAoD,EAAE;YACxG,GAAG,IAAI,CAAC,cAAc;YACtB,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG;SACjB,CAAC,CAAC;QAEH,IACE,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CACpC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,MAAM,KAAK,WAAW,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,UAAU,CAAC,CACpF,EACD;YACA,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAEO,KAAK,CAAC,WAAW;QACvB,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,+CAA+C,EAAE;YACjG,GAAG,IAAI,CAAC,iBAAiB;SAC1B,CAAC,CAAC;QACH,2GAA2G;QAC3G,+DAA+D;QAC/D,IAAI,cAAc,CAAC,IAAI,CAAC,SAAS,KAAK,IAAI,IAAI,cAAc,CAAC,IAAI,CAAC,eAAe,KAAK,QAAQ,EAAE;YAC9F,OAAO,IAAI,CAAC;SACb;IACH,CAAC;;AA1IH,4BA2IC;AA1IwB,iBAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAC7C,qBAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AACjD,kBAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;AAE5C,eAAK,GAAG;IAC7B,KAAK,EAAE,uBAAK,CAAC,MAAM,CAAC;QAClB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC;QACrC,SAAS,EAAE,CAAC,MAAM,CAAC;QACnB,OAAO,EAAE,CAAC,KAAK,CAAC;QAChB,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,IAAI,EAAE,uBAAK,CAAC,MAAM,CAAC;QACjB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;QACpC,SAAS,EAAE,CAAC,OAAO,CAAC;QACpB,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,aAAa,EAAE,uBAAK,CAAC,OAAO,CAAC;QAC3B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC;QAC3C,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,SAAS,EAAE,uBAAK,CAAC,OAAO,CAAC;QACvB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC;QACvC,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,KAAK;KACf,CAAC;IACF,OAAO,EAAE,uBAAK,CAAC,OAAO,CAAC;QACrB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC;QACvC,OAAO,EAAE,KAAK;KACf,CAAC;CACH,CAAC"}

package/messages/cli.release.automerge.json

@@ -0,0 +1,9 @@
+{
+  "description": "Attempt to automerge nightly PR",
+  "owner": "Github owner (org), example: salesforcecli",
+  "repo": "Github repo, example: sfdx-cli",
+  "pull-number": "Github pull request number to merge",
+  "dry-run": "Run all checks, but do not merge PR",
+  "verbose": "Show additional debug output",
+  "examples": ["<%= config.bin %> <%= command.id %> --owner salesforcecli --repo sfdx-cli --pul-number 1049"]
+}

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.15.9",
+  "version": "3.16.0",
   "commands": {
     "channel:promote": {
       "id": "channel:promote",
@@ -617,6 +617,72 @@
       },
       "args": {}
     },
+    "cli:release:automerge": {
+      "id": "cli:release:automerge",
+      "summary": "Attempt to automerge nightly PR",
+      "description": "Attempt to automerge nightly PR",
+      "strict": true,
+      "pluginName": "@salesforce/plugin-release-management",
+      "pluginAlias": "@salesforce/plugin-release-management",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --owner salesforcecli --repo sfdx-cli --pul-number 1049"
+      ],
+      "flags": {
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "allowNo": false
+        },
+        "owner": {
+          "name": "owner",
+          "type": "option",
+          "summary": "Github owner (org), example: salesforcecli",
+          "required": true,
+          "multiple": false,
+          "dependsOn": [
+            "repo"
+          ],
+          "aliases": [
+            "org"
+          ]
+        },
+        "repo": {
+          "name": "repo",
+          "type": "option",
+          "summary": "Github repo, example: sfdx-cli",
+          "required": true,
+          "multiple": false,
+          "dependsOn": [
+            "owner"
+          ]
+        },
+        "pull-number": {
+          "name": "pull-number",
+          "type": "option",
+          "summary": "Github pull request number to merge",
+          "required": true,
+          "multiple": false
+        },
+        "dry-run": {
+          "name": "dry-run",
+          "type": "boolean",
+          "char": "d",
+          "summary": "Run all checks, but do not merge PR",
+          "allowNo": false
+        },
+        "verbose": {
+          "name": "verbose",
+          "type": "boolean",
+          "summary": "Show additional debug output",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
     "cli:release:build": {
       "id": "cli:release:build",
       "summary": "builds a new release from a designated starting point and optionally creates PR in Github",

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@salesforce/plugin-release-management",
     "description": "A plugin for preparing and publishing npm packages",
-    "version": "3.15.9",
+    "version": "3.16.0",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "bin": {
@@ -290,7 +290,7 @@
         }
     },
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-release-management/3.15.9.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-release-management/3.15.9.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-release-management/3.16.0.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-release-management/3.16.0.sig"
     }
 }