Show more neutral status when backport is skipped due to missing bran…

…ches
sorenlouv · Jan 23, 2022 · 326d76c · 326d76c
1 parent aca231b
commit 326d76c
Show file tree

Hide file tree

Showing 16 changed files with 219 additions and 111 deletions.
diff --git a/src/backportRun.ts b/src/backportRun.ts
@@ -21,8 +21,7 @@ export type BackportResponse =
   | {
       status: 'failure';
       commits: Commit[];
-      errorMessage: string;
-      error: Error;
+      error: Error | HandledError;
     };
 
 export async function backportRun(
@@ -37,6 +36,7 @@ export async function backportRun(
 
   // don't show spinner for yargs commands that exit the process without stopping the spinner first
   const spinner = ora();
+
   if (!argv.help && !argv.version) {
     spinner.start('Initializing...');
   }
@@ -67,7 +67,6 @@ export async function backportRun(
     const backportResponse: BackportResponse = {
       status: 'failure',
       commits,
-      errorMessage: e.message,
       error: e,
     };
 

diff --git a/src/runSequentially.test.ts b/src/runSequentially.test.ts
@@ -143,6 +143,8 @@ describe('runSequentially', () => {
       This is an automatic backport to \`7.x\` of:
        - #55
 
+      <!--- Backport version: 1.2.3 -->
+
       ### Questions ?
       Please refer to the [Backport tool documentation](https://github.com/sqren/backport)",
           "head": "sqren_authenticated:backport/7.x/pr-55",

diff --git a/src/runSequentially.ts b/src/runSequentially.ts
@@ -19,7 +19,6 @@ export type Result =
       // only set for failure
       status: 'failure';
       targetBranch: string;
-      errorMessage: string;
       error: HandledError;
     };
 
@@ -56,7 +55,6 @@ export async function runSequentially({
       results.push({
         targetBranch,
         status: 'failure',
-        errorMessage: e.message,
         error: e,
       });
       consoleLog(e.message);

diff --git a/src/services/HandledError.ts b/src/services/HandledError.ts
@@ -1,19 +1,41 @@
 import { Commit } from './sourceCommit/parseSourceCommit';
 
-type Meta = {
-  type: 'merge-conflict-due-to-missing-backports';
-  commitsWithoutBackports: {
-    formatted: string;
-    commit: Commit;
-  }[];
-};
+type ErrorAttributes =
+  | {
+      code: 'merge-conflict-exception';
+      commitsWithoutBackports: {
+        formatted: string;
+        commit: Commit;
+      }[];
+    }
+  | {
+      code: 'no-branches-exception' | 'abort-exception';
+    };
+
+function getMessage(errorAttributes: ErrorAttributes | string): string {
+  if (typeof errorAttributes === 'string') {
+    return errorAttributes;
+  }
+
+  switch (errorAttributes.code) {
+    case 'merge-conflict-exception':
+      return `Commit could not be cherrypicked due to conflicts`;
+    case 'no-branches-exception':
+      return 'There are no branches to backport to. Aborting.';
+    case 'abort-exception':
+      return 'Aborted';
+  }
+}
 
 export class HandledError extends Error {
-  meta?: Meta;
-  constructor(message: string, meta?: Meta) {
-    super(message);
+  attributes?: ErrorAttributes;
+  constructor(errorAttributes: ErrorAttributes | string) {
+    super(getMessage(errorAttributes));
     Error.captureStackTrace(this, HandledError);
     this.name = 'HandledError';
-    this.meta = meta;
+
+    if (typeof errorAttributes !== 'string') {
+      this.attributes = errorAttributes;
+    }
   }
 }
diff --git a/src/services/github/v3/createPullRequest.test.ts b/src/services/github/v3/createPullRequest.test.ts
@@ -23,6 +23,8 @@ describe('getPullRequestBody', () => {
       This is an automatic backport to \`7.x\` of:
        - #55
 
+      <!--- Backport version: 1.2.3 -->
+
       ### Questions ?
       Please refer to the [Backport tool documentation](https://github.com/sqren/backport)"
     `);
@@ -47,6 +49,8 @@ describe('getPullRequestBody', () => {
       This is an automatic backport to \`7.x\` of:
        - My commit message (abcdefgh)
 
+      <!--- Backport version: 1.2.3 -->
+
       ### Questions ?
       Please refer to the [Backport tool documentation](https://github.com/sqren/backport)"
     `);
@@ -77,6 +81,8 @@ describe('getPullRequestBody', () => {
        - #55
        - Another commit message (qwertyui)
 
+      <!--- Backport version: 1.2.3 -->
+
       ### Questions ?
       Please refer to the [Backport tool documentation](https://github.com/sqren/backport)"
     `);
@@ -137,6 +143,8 @@ describe('getPullRequestBody', () => {
        - #55
        - Another commit message (qwertyui)
 
+      <!--- Backport version: 1.2.3 -->
+
       ### Questions ?
       Please refer to the [Backport tool documentation](https://github.com/sqren/backport)
 

diff --git a/src/services/github/v3/createPullRequest.ts b/src/services/github/v3/createPullRequest.ts
@@ -1,6 +1,7 @@
 import { Octokit } from '@octokit/rest';
 import ora from 'ora';
 import { ValidConfigOptions } from '../../../options/options';
+import { getPackageVersion } from '../../../utils/getPackageVersion';
 import { HandledError } from '../../HandledError';
 import { logger } from '../../logger';
 import { Commit } from '../../sourceCommit/parseSourceCommit';
@@ -104,6 +105,8 @@ export function getPullRequestBody({
 This is an automatic backport to \`${targetBranch}\` of:
 ${commitMessages}
 
+<!--- Backport version: ${getPackageVersion()} -->
+
 ### Questions ?
 Please refer to the [Backport tool documentation](https://github.com/sqren/backport)`;