Automatically check brances when selecting multiple commits

src/__snapshots__/runWithOptions.test.ts.snap

@@ -93,6 +93,7 @@ Array [
               "pullNumber": undefined,
               "sha": "2e63475c483f7844b0f2833bc57fdee32095bacb",
               "sourceBranch": "mySourceBranch",
+              "targetBranches": Array [],
             },
           },
           Object {
@@ -104,6 +105,7 @@ Array [
               "pullNumber": 85,
               "sha": "f3b618b9421fdecdb36862f907afbdd6344b361d",
               "sourceBranch": "mySourceBranch",
+              "targetBranches": Array [],
             },
           },
           Object {
@@ -120,6 +122,7 @@ Array [
               "pullNumber": 80,
               "sha": "79cf18453ec32a4677009dcbab1c9c8c73fc14fe",
               "sourceBranch": "mySourceBranch",
+              "targetBranches": Array [],
             },
           },
           Object {
@@ -131,6 +134,7 @@ Array [
               "pullNumber": undefined,
               "sha": "3827bbbaf39914eda4f02f6940189844375fd097",
               "sourceBranch": "mySourceBranch",
+              "targetBranches": Array [],
             },
           },
           Object {
@@ -142,12 +146,17 @@ Array [
               "pullNumber": undefined,
               "sha": "5ea0da550ac191029459289d67f99ad7d310812b",
               "sourceBranch": "mySourceBranch",
+              "targetBranches": Array [],
             },
           },
+          Separator {
+            "line": "──────────────",
+            "type": "separator",
+          },
         ],
         "message": "Select commit to backport",
         "name": "promptResult",
-        "pageSize": 5,
+        "pageSize": 15,
         "type": "list",
       },
     ],
@@ -171,9 +180,14 @@ Array [
           Object {
             "name": "5.4",
           },
+          Separator {
+            "line": "──────────────",
+            "type": "separator",
+          },
         ],
         "message": "Select branch to backport to",
         "name": "promptResult",
+        "pageSize": 15,
         "type": "list",
       },
     ],

src/options/__snapshots__/options.test.ts.snap

@@ -15,7 +15,7 @@ Read more: https://github.com/sqren/backport/blob/434a28b431bb58c9a014d4489a95f5
 `;
 
 exports[`validateRequiredOptions should throw when both branches and targetBranchChoices are missing 1`] = `
-"You must specify one or more target branches
+"You must specify a target branch
 
 You can specify it via either:
  - Config file (recommended): \\".backportrc.json\\". Read more: https://github.com/sqren/backport/blob/434a28b431bb58c9a014d4489a95f561e6bb2769/docs/configuration.md#project-config-backportrcjson

src/options/cliArgs.ts

@@ -43,6 +43,7 @@ export function getOptionsFromCliArgs(
     .option('commitsCount', {
       default: configOptions.commitsCount,
       description: 'Number of commits to choose from',
+      alias: 'count',
       type: 'number',
     })
     .option('editor', {

src/options/options.ts

@@ -43,7 +43,7 @@ export function validateRequiredOptions({
 
   if (isEmpty(options.targetBranches) && isEmpty(options.targetBranchChoices)) {
     throw new HandledError(
-      `You must specify one or more target branches\n\nYou can specify it via either:\n - Config file (recommended): ".backportrc.json". Read more: ${PROJECT_CONFIG_DOCS_LINK}\n - CLI: "--branch 6.1"`
+      `You must specify a target branch\n\nYou can specify it via either:\n - Config file (recommended): ".backportrc.json". Read more: ${PROJECT_CONFIG_DOCS_LINK}\n - CLI: "--branch 6.1"`
     );
   }
 

src/services/git.test.ts

@@ -150,6 +150,7 @@ describe('cherrypick', () => {
     sourceBranch: '7.x',
     formattedMessage: '',
     sha: 'abcd',
+    targetBranches: [],
   };
 
   it('should swallow cherrypick error', async () => {

src/services/github/v3/fetchCommitBySha.test.ts

@@ -29,6 +29,7 @@ describe('fetchCommitBySha', () => {
       formattedMessage: 'myMessage (sha12345)',
       pullNumber: undefined,
       sha: 'sha123456789',
+      targetBranches: [],
     });
 
     expect(axiosSpy.mock.calls).toMatchSnapshot();

src/services/github/v3/fetchCommitBySha.ts

@@ -55,6 +55,7 @@ export async function fetchCommitBySha(
 
   return {
     sourceBranch: 'master',
+    targetBranches: [],
     formattedMessage,
     sha: fullSha,
   };

src/services/github/v4/__snapshots__/fetchCommitsByAuthor.test.ts.snap

@@ -63,6 +63,11 @@ Array [
                           mergeCommit {
                             oid
                           }
+                          labels(first: 50) {
+                            nodes {
+                              name
+                            }
+                          }
                           timelineItems(
                             last: 20
                             itemTypes: CROSS_REFERENCED_EVENT
@@ -109,7 +114,7 @@ Array [
       "historyPath": null,
       "repoName": "kibana",
       "repoOwner": "elastic",
-      "sourceBranch": undefined,
+      "sourceBranch": "master",
     },
   },
   Object {

src/services/github/v4/fetchCommitByPullNumber.test.ts

@@ -1,4 +1,4 @@
-import { getTargetBranchesFromLabels } from './fetchCommitByPullNumber';
+import { getTargetBranchesFromLabels } from './getTargetBranchesFromLabels';
 
 describe('getTargetBranchesFromLabels', () => {
   it(`should support Kibana's label format`, () => {
@@ -32,10 +32,10 @@ describe('getTargetBranchesFromLabels', () => {
       'v7.8.0', // 7.x
       'v8.0.0', // master
     ];
-    const targetBranches = getTargetBranchesFromLabels(
+    const targetBranches = getTargetBranchesFromLabels({
       labels,
-      branchLabelMapping
-    );
+      branchLabelMapping,
+    });
     expect(targetBranches).toEqual([
       '5.4',
       '5.5',
@@ -67,10 +67,10 @@ describe('getTargetBranchesFromLabels', () => {
       'label-(\\d+)': 'branch-$1',
     };
     const labels = ['label-2'];
-    const targetBranches = getTargetBranchesFromLabels(
+    const targetBranches = getTargetBranchesFromLabels({
       labels,
-      branchLabelMapping
-    );
+      branchLabelMapping,
+    });
     expect(targetBranches).toEqual(['branch-b']);
   });
 
@@ -79,10 +79,10 @@ describe('getTargetBranchesFromLabels', () => {
       'label-(\\d+)': 'branch-$1',
     };
     const labels = ['label-1', 'label-2', 'label-2'];
-    const targetBranches = getTargetBranchesFromLabels(
+    const targetBranches = getTargetBranchesFromLabels({
       labels,
-      branchLabelMapping
-    );
+      branchLabelMapping,
+    });
     expect(targetBranches).toEqual(['branch-1', 'branch-2']);
   });
 
@@ -91,10 +91,10 @@ describe('getTargetBranchesFromLabels', () => {
       'label-(\\d+)': 'branch-$1',
     };
     const labels = ['label-1', 'label-2', 'foo', 'bar'];
-    const targetBranches = getTargetBranchesFromLabels(
+    const targetBranches = getTargetBranchesFromLabels({
       labels,
-      branchLabelMapping
-    );
+      branchLabelMapping,
+    });
     expect(targetBranches).toEqual(['branch-1', 'branch-2']);
   });
 
@@ -104,10 +104,10 @@ describe('getTargetBranchesFromLabels', () => {
       'label-(\\d+)': 'branch-$1',
     };
     const labels = ['label-1', 'label-2'];
-    const targetBranches = getTargetBranchesFromLabels(
+    const targetBranches = getTargetBranchesFromLabels({
       labels,
-      branchLabelMapping
-    );
+      branchLabelMapping,
+    });
     expect(targetBranches).toEqual(['branch-1']);
   });
 });

src/services/github/v4/fetchCommitByPullNumber.ts

@@ -1,10 +1,9 @@
-import uniq from 'lodash.uniq';
 import { BackportOptions } from '../../../options/options';
 import { CommitSelected } from '../../../types/Commit';
-import { filterEmpty } from '../../../utils/filterEmpty';
 import { HandledError } from '../../HandledError';
 import { getFormattedCommitMessage } from '../commitFormatters';
 import { apiRequestV4 } from './apiRequestV4';
+import { getTargetBranchesFromLabels } from './getTargetBranchesFromLabels';
 
 export async function fetchCommitByPullNumber(
   options: BackportOptions & { pullNumber: number }
@@ -57,9 +56,6 @@ export async function fetchCommitByPullNumber(
     throw new HandledError(`The PR #${pullNumber} is not merged`);
   }
 
-  const labels = res.repository.pullRequest.labels.nodes.map(
-    (label) => label.name
-  );
   const sourceBranch = res.repository.pullRequest.baseRef.name;
   const sha = res.repository.pullRequest.mergeCommit.oid;
   const formattedMessage = getFormattedCommitMessage({
@@ -68,10 +64,13 @@ export async function fetchCommitByPullNumber(
     pullNumber,
   });
 
-  const targetBranches = getTargetBranchesFromLabels(
-    labels,
-    branchLabelMapping
+  const labels = res.repository.pullRequest.labels.nodes.map(
+    (label) => label.name
   );
+  const targetBranches = getTargetBranchesFromLabels({
+    labels,
+    branchLabelMapping,
+  });
 
   return {
     sourceBranch,
@@ -100,33 +99,3 @@ interface DataResponse {
     };
   };
 }
-
-export function getTargetBranchesFromLabels(
-  labels: string[],
-  branchLabelMapping?: Record<string, string>
-) {
-  if (!branchLabelMapping) {
-    return [];
-  }
-  const targetBranches = labels
-    .flatMap((label) => {
-      // only get first match
-      const result = Object.entries(branchLabelMapping).find(
-        ([labelPattern]) => {
-          const regex = new RegExp(labelPattern);
-          const isMatch = label.match(regex) !== null;
-          return isMatch;
-        }
-      );
-
-      if (result) {
-        const [labelPattern, targetBranch] = result;
-        const regex = new RegExp(labelPattern);
-        return label.replace(regex, targetBranch);
-      }
-    })
-    .filter((targetBranch) => targetBranch !== '')
-    .filter(filterEmpty);
-
-  return uniq(targetBranches);
-}

src/services/github/v4/fetchCommitsByAuthor.test.ts

@@ -1,6 +1,6 @@
 import axios from 'axios';
-import { getDefaultOptions } from '../../../test/getDefaultOptions';
-import { CommitSelected } from '../../../types/Commit';
+import { BackportOptions } from '../../../options/options';
+import { CommitSelected, CommitChoice } from '../../../types/Commit';
 import { SpyHelper } from '../../../types/SpyHelper';
 import {
   fetchCommitsByAuthor,
@@ -31,35 +31,46 @@ describe('fetchCommitsByAuthor', () => {
     });
 
     it('Should return a list of commits with pullNumber and existing backports', () => {
-      expect(res).toEqual([
+      const expectedCommits: CommitChoice[] = [
         {
           sha: '2e63475c483f7844b0f2833bc57fdee32095bacb',
           formattedMessage: 'Add 👻 (2e63475c)',
           existingBackports: [],
+          targetBranches: [],
+          sourceBranch: 'master',
         },
         {
           sha: 'f3b618b9421fdecdb36862f907afbdd6344b361d',
           formattedMessage: 'Add witch (#85)',
           pullNumber: 85,
           existingBackports: [],
+          targetBranches: [],
+          sourceBranch: 'master',
         },
         {
           sha: '79cf18453ec32a4677009dcbab1c9c8c73fc14fe',
           formattedMessage: 'Add SF mention (#80)',
           pullNumber: 80,
           existingBackports: [{ branch: '6.3', state: 'MERGED' }],
+          targetBranches: [],
+          sourceBranch: 'master',
         },
         {
           sha: '3827bbbaf39914eda4f02f6940189844375fd097',
           formattedMessage: 'Add backport config (3827bbba)',
           existingBackports: [],
+          targetBranches: [],
+          sourceBranch: 'master',
         },
         {
           sha: '5ea0da550ac191029459289d67f99ad7d310812b',
           formattedMessage: 'Initial commit (5ea0da55)',
           existingBackports: [],
+          targetBranches: [],
+          sourceBranch: 'master',
         },
-      ]);
+      ];
+      expect(res).toEqual(expectedCommits);
     });
 
     it('should call with correct args to fetch author id', () => {
@@ -74,26 +85,32 @@ describe('fetchCommitsByAuthor', () => {
   describe('existingBackports', () => {
     it('should return existingBackports when repoNames match', async () => {
       const res = await getExistingBackportsByRepoName('kibana', 'kibana');
-      expect(res).toEqual([
+      const expectedCommits: CommitChoice[] = [
         {
           existingBackports: [{ branch: '6.3', state: 'MERGED' }],
           formattedMessage: 'Add SF mention (#80)',
           pullNumber: 80,
           sha: '79cf18453ec32a4677009dcbab1c9c8c73fc14fe',
+          sourceBranch: 'master',
+          targetBranches: [],
         },
-      ]);
+      ];
+      expect(res).toEqual(expectedCommits);
     });
 
     it('should not return existingBackports when repoNames does not match', async () => {
       const res = await getExistingBackportsByRepoName('kibana', 'kibana2');
-      expect(res).toEqual([
+      const expectedCommits: CommitChoice[] = [
         {
           existingBackports: [],
           formattedMessage: 'Add SF mention (#80)',
           pullNumber: 80,
           sha: '79cf18453ec32a4677009dcbab1c9c8c73fc14fe',
+          sourceBranch: 'master',
+          targetBranches: [],
         },
-      ]);
+      ];
+      expect(res).toEqual(expectedCommits);
     });
   });
 
@@ -201,3 +218,17 @@ async function getExistingBackportsByRepoName(
   });
   return fetchCommitsByAuthor(options);
 }
+
+function getDefaultOptions(options: Partial<BackportOptions> = {}) {
+  return {
+    repoOwner: 'elastic',
+    repoName: 'kibana',
+    sourceBranch: 'master',
+    accessToken: 'myAccessToken',
+    username: 'sqren',
+    author: 'sqren',
+    githubApiBaseUrlV3: 'https://api.github.com',
+    githubApiBaseUrlV4: 'https://api.github.com/graphql',
+    ...options,
+  } as BackportOptions;
+}