feat: add --cherry-pick-options to add to all cherry-pick run (#116)

Fixes: #111

README.md

@@ -124,6 +124,7 @@ This tool comes with some inputs that allow users to override the default behavi
 | No squash       | --no-squash        | N            | If provided the backporting will try to backport all pull request commits without squashing                                                           | false       |
 | Strategy       | --strategy        | N            | Cherry pick merging strategy, see [git-merge](https://git-scm.com/docs/git-merge#_merge_strategies) doc for all possible values                                                           | "recursive"       |
 | Strategy Option       | --strategy-option        | N            | Cherry pick merging strategy option, see [git-merge](https://git-scm.com/docs/git-merge#_merge_strategies) doc for all possible values                                                           | "theirs"       |
+| Cherry-pick Options       | --cherry-pick-options        | N            | Additional cherry-pick options, see [git-cherry-pick](https://git-scm.com/docs/git-cherry-pick) doc for all possible values                                                           | "theirs"       |
 | Additional comments       | --comments        | N            | Semicolon separated list of additional comments to be posted to the backported pull request                                                           | []       |
 | Dry Run       | -d, --dry-run        | N            | If enabled the tool does not push nor create anything remotely, use this to skip PR creation                                                           | false       |
 

action.yml

@@ -97,6 +97,10 @@ inputs:
     description: Cherry-pick merge strategy option
     required: false
     default: "theirs"
+  cherry-pick-options:
+    description: >
+      Additional cherry-pick options
+    required: false
   comments:
     description: >
       Semicolon separated list of additional comments to be posted to the backported pull request

dist/cli/index.js

@@ -68,6 +68,7 @@ class ArgsParser {
             squash: this.getOrDefault(args.squash, true),
             strategy: this.getOrDefault(args.strategy),
             strategyOption: this.getOrDefault(args.strategyOption),
+            cherryPickOptions: this.getOrDefault(args.cherryPickOptions),
             comments: this.getOrDefault(args.comments)
         };
     }
@@ -205,6 +206,7 @@ class CLIArgsParser extends args_parser_1.default {
             .option("--no-squash", "if provided the tool will backport all commits as part of the pull request")
             .option("--strategy <strategy>", "cherry-pick merge strategy, default to 'recursive'", undefined)
             .option("--strategy-option <strategy-option>", "cherry-pick merge strategy option, default to 'theirs'")
+            .option("--cherry-pick-options <options>", "additional cherry-pick options")
             .option("--comments <comments>", "semicolon separated list of additional comments to be posted to the backported pull request", args_utils_1.getAsSemicolonSeparatedList)
             .option("-cf, --config-file <config-file>", "configuration file containing all valid options, the json must match Args interface");
     }
@@ -240,6 +242,7 @@ class CLIArgsParser extends args_parser_1.default {
                 squash: opts.squash,
                 strategy: opts.strategy,
                 strategyOption: opts.strategyOption,
+                cherryPickOptions: opts.cherryPickOptions,
                 comments: opts.comments,
             };
         }
@@ -359,6 +362,7 @@ class PullRequestConfigsParser extends configs_parser_1.default {
             folder: `${folder.startsWith("/") ? "" : process.cwd() + "/"}${args.folder ?? this.getDefaultFolder()}`,
             mergeStrategy: args.strategy,
             mergeStrategyOption: args.strategyOption,
+            cherryPickOptions: args.cherryPickOptions,
             originalPullRequest: pr,
             backportPullRequests: this.generateBackportPullRequestsData(pr, args, targetBranches, bpBranchNames),
             git: {
@@ -555,9 +559,14 @@ class GitCLIService {
      * @param cwd repository in which the sha should be cherry picked to
      * @param sha commit sha
      */
-    async cherryPick(cwd, sha, strategy = "recursive", strategyOption = "theirs") {
+    async cherryPick(cwd, sha, strategy = "recursive", strategyOption = "theirs", cherryPickOptions) {
         this.logger.info(`Cherry picking ${sha}`);
-        const options = ["cherry-pick", "-m", "1", `--strategy=${strategy}`, `--strategy-option=${strategyOption}`, sha];
+        let options = ["cherry-pick", "-m", "1", `--strategy=${strategy}`, `--strategy-option=${strategyOption}`];
+        if (cherryPickOptions !== undefined) {
+            options = options.concat(cherryPickOptions.split(" "));
+        }
+        options.push(sha);
+        this.logger.debug(`Cherry picking command git ${options}`);
         try {
             await this.git(cwd).raw(options);
         }
@@ -1461,7 +1470,7 @@ class Runner {
         // 7. apply all changes to the new branch
         this.logger.debug("Cherry picking commits..");
         for (const sha of originalPR.commits) {
-            await git.gitCli.cherryPick(configs.folder, sha, configs.mergeStrategy, configs.mergeStrategyOption);
+            await git.gitCli.cherryPick(configs.folder, sha, configs.mergeStrategy, configs.mergeStrategyOption, configs.cherryPickOptions);
         }
         if (!configs.dryRun) {
             // 8. push the new branch to origin
@@ -23801,4 +23810,4 @@ module.exports = JSON.parse('[[[0,44],"disallowed_STD3_valid"],[[45,46],"valid"]
 /******/ 	module.exports = __webpack_exports__;
 /******/ 	
 /******/ })()
-;
+;

dist/gha/index.js

@@ -68,6 +68,7 @@ class ArgsParser {
             squash: this.getOrDefault(args.squash, true),
             strategy: this.getOrDefault(args.strategy),
             strategyOption: this.getOrDefault(args.strategyOption),
+            cherryPickOptions: this.getOrDefault(args.cherryPickOptions),
             comments: this.getOrDefault(args.comments)
         };
     }
@@ -208,6 +209,7 @@ class GHAArgsParser extends args_parser_1.default {
                 squash: !(0, args_utils_1.getAsBooleanOrDefault)((0, core_1.getInput)("no-squash")),
                 strategy: (0, args_utils_1.getOrUndefined)((0, core_1.getInput)("strategy")),
                 strategyOption: (0, args_utils_1.getOrUndefined)((0, core_1.getInput)("strategy-option")),
+                cherryPickOptions: (0, args_utils_1.getOrUndefined)((0, core_1.getInput)("cherry-pick-options")),
                 comments: (0, args_utils_1.getAsSemicolonSeparatedList)((0, core_1.getInput)("comments")),
             };
         }
@@ -327,6 +329,7 @@ class PullRequestConfigsParser extends configs_parser_1.default {
             folder: `${folder.startsWith("/") ? "" : process.cwd() + "/"}${args.folder ?? this.getDefaultFolder()}`,
             mergeStrategy: args.strategy,
             mergeStrategyOption: args.strategyOption,
+            cherryPickOptions: args.cherryPickOptions,
             originalPullRequest: pr,
             backportPullRequests: this.generateBackportPullRequestsData(pr, args, targetBranches, bpBranchNames),
             git: {
@@ -523,9 +526,14 @@ class GitCLIService {
      * @param cwd repository in which the sha should be cherry picked to
      * @param sha commit sha
      */
-    async cherryPick(cwd, sha, strategy = "recursive", strategyOption = "theirs") {
+    async cherryPick(cwd, sha, strategy = "recursive", strategyOption = "theirs", cherryPickOptions) {
         this.logger.info(`Cherry picking ${sha}`);
-        const options = ["cherry-pick", "-m", "1", `--strategy=${strategy}`, `--strategy-option=${strategyOption}`, sha];
+        let options = ["cherry-pick", "-m", "1", `--strategy=${strategy}`, `--strategy-option=${strategyOption}`];
+        if (cherryPickOptions !== undefined) {
+            options = options.concat(cherryPickOptions.split(" "));
+        }
+        options.push(sha);
+        this.logger.debug(`Cherry picking command git ${options}`);
         try {
             await this.git(cwd).raw(options);
         }
@@ -1429,7 +1437,7 @@ class Runner {
         // 7. apply all changes to the new branch
         this.logger.debug("Cherry picking commits..");
         for (const sha of originalPR.commits) {
-            await git.gitCli.cherryPick(configs.folder, sha, configs.mergeStrategy, configs.mergeStrategyOption);
+            await git.gitCli.cherryPick(configs.folder, sha, configs.mergeStrategy, configs.mergeStrategyOption, configs.cherryPickOptions);
         }
         if (!configs.dryRun) {
             // 8. push the new branch to origin

src/service/args/args-parser.ts

@@ -46,6 +46,7 @@ export default abstract class ArgsParser {
       squash: this.getOrDefault(args.squash, true),
       strategy: this.getOrDefault(args.strategy),
       strategyOption: this.getOrDefault(args.strategyOption),
+      cherryPickOptions: this.getOrDefault(args.cherryPickOptions),
       comments: this.getOrDefault(args.comments)
     };
   }

src/service/args/args.types.ts

@@ -25,5 +25,6 @@ export interface Args {
   squash?: boolean, // if false use squashed/merged commit otherwise backport all commits as part of the pr
   strategy?: string, // cherry-pick merge strategy
   strategyOption?: string, // cherry-pick merge strategy option
+  cherryPickOptions?: string, // additional cherry-pick options
   comments?: string[], // additional comments to be posted
 }

src/service/args/cli/cli-args-parser.ts

@@ -31,6 +31,7 @@ export default class CLIArgsParser extends ArgsParser {
       .option("--no-squash", "if provided the tool will backport all commits as part of the pull request")
       .option("--strategy <strategy>", "cherry-pick merge strategy, default to 'recursive'", undefined)
       .option("--strategy-option <strategy-option>", "cherry-pick merge strategy option, default to 'theirs'")
+      .option("--cherry-pick-options <options>", "additional cherry-pick options")
       .option("--comments <comments>", "semicolon separated list of additional comments to be posted to the backported pull request", getAsSemicolonSeparatedList)
       .option("-cf, --config-file <config-file>", "configuration file containing all valid options, the json must match Args interface");
   }
@@ -67,6 +68,7 @@ export default class CLIArgsParser extends ArgsParser {
         squash: opts.squash,
         strategy: opts.strategy,
         strategyOption: opts.strategyOption,
+        cherryPickOptions: opts.cherryPickOptions,
         comments: opts.comments,
       };
     }

src/service/args/gha/gha-args-parser.ts

@@ -34,6 +34,7 @@ export default class GHAArgsParser extends ArgsParser {
         squash: !getAsBooleanOrDefault(getInput("no-squash")),
         strategy: getOrUndefined(getInput("strategy")),
         strategyOption: getOrUndefined(getInput("strategy-option")),
+        cherryPickOptions: getOrUndefined(getInput("cherry-pick-options")),
         comments: getAsSemicolonSeparatedList(getInput("comments")),
       };
     }

src/service/configs/configs.types.ts

@@ -17,6 +17,7 @@ export interface Configs {
   folder: string,
   mergeStrategy?: string, // cherry-pick merge strategy
   mergeStrategyOption?: string, // cherry-pick merge strategy option
+  cherryPickOptions?: string, // additional cherry-pick options
   originalPullRequest: GitPullRequest,
   backportPullRequests: BackportPullRequest[],
  }

src/service/configs/pullrequest/pr-configs-parser.ts

@@ -49,6 +49,7 @@ export default class PullRequestConfigsParser extends ConfigsParser {
       folder: `${folder.startsWith("/") ? "" : process.cwd() + "/"}${args.folder ?? this.getDefaultFolder()}`,
       mergeStrategy: args.strategy,
       mergeStrategyOption: args.strategyOption,
+      cherryPickOptions: args.cherryPickOptions,
       originalPullRequest: pr,
       backportPullRequests: this.generateBackportPullRequestsData(pr, args, targetBranches, bpBranchNames),
       git: {

src/service/git/git-cli.ts

@@ -110,10 +110,15 @@ export default class GitCLIService {
    * @param cwd repository in which the sha should be cherry picked to
    * @param sha commit sha
    */
-  async cherryPick(cwd: string, sha: string, strategy = "recursive", strategyOption = "theirs"): Promise<void> {
+  async cherryPick(cwd: string, sha: string, strategy = "recursive", strategyOption = "theirs", cherryPickOptions: string | undefined): Promise<void> {
     this.logger.info(`Cherry picking ${sha}`);
 
-    const options = ["cherry-pick", "-m", "1", `--strategy=${strategy}`, `--strategy-option=${strategyOption}`, sha];
+    let options = ["cherry-pick", "-m", "1", `--strategy=${strategy}`, `--strategy-option=${strategyOption}`];
+    if (cherryPickOptions !== undefined) {
+      options = options.concat(cherryPickOptions.split(" "));
+    }
+    options.push(sha);
+    this.logger.debug(`Cherry picking command git ${options}`);
     try {
       await this.git(cwd).raw(options);
     } catch(error) {

src/service/runner/runner.ts

@@ -147,7 +147,7 @@ export default class Runner {
     // 7. apply all changes to the new branch
     this.logger.debug("Cherry picking commits..");
     for (const sha of originalPR.commits!) {
-      await git.gitCli.cherryPick(configs.folder, sha, configs.mergeStrategy, configs.mergeStrategyOption);
+      await git.gitCli.cherryPick(configs.folder, sha, configs.mergeStrategy, configs.mergeStrategyOption, configs.cherryPickOptions);
     }
 
     if (!configs.dryRun) {

test/service/args/cli/cli-args-parser.test.ts

@@ -81,6 +81,7 @@ describe("cli args parser", () => {
     expect(args.squash).toEqual(true);
     expect(args.strategy).toEqual(undefined);
     expect(args.strategyOption).toEqual(undefined);
+    expect(args.cherryPickOptions).toEqual(undefined);
   });
 
   test("with config file [default, short]", () => {
@@ -110,6 +111,7 @@ describe("cli args parser", () => {
     expect(args.squash).toEqual(true);
     expect(args.strategy).toEqual(undefined);
     expect(args.strategyOption).toEqual(undefined);
+    expect(args.cherryPickOptions).toEqual(undefined);
   });
 
   test("valid execution [default, long]", () => {
@@ -141,6 +143,7 @@ describe("cli args parser", () => {
     expect(args.squash).toEqual(true);
     expect(args.strategy).toEqual(undefined);
     expect(args.strategyOption).toEqual(undefined);
+    expect(args.cherryPickOptions).toEqual(undefined);
   });
 
   test("with config file [default, long]", () => {
@@ -170,6 +173,7 @@ describe("cli args parser", () => {
     expect(args.squash).toEqual(true);
     expect(args.strategy).toEqual(undefined);
     expect(args.strategyOption).toEqual(undefined);
+    expect(args.cherryPickOptions).toEqual(undefined);
   });
 
   test("valid execution [override, short]", () => {
@@ -208,6 +212,7 @@ describe("cli args parser", () => {
     expect(args.squash).toEqual(true);
     expect(args.strategy).toEqual(undefined);
     expect(args.strategyOption).toEqual(undefined);
+    expect(args.cherryPickOptions).toEqual(undefined);
   });
 
   test("valid execution [override, long]", () => {
@@ -264,6 +269,7 @@ describe("cli args parser", () => {
     expect(args.squash).toEqual(true);
     expect(args.strategy).toEqual(undefined);
     expect(args.strategyOption).toEqual(undefined);
+    expect(args.cherryPickOptions).toEqual(undefined);
   });
 
   test("override using config file", () => {
@@ -293,6 +299,7 @@ describe("cli args parser", () => {
     expect(args.squash).toEqual(true);
     expect(args.strategy).toEqual(undefined);
     expect(args.strategyOption).toEqual(undefined);
+    expect(args.cherryPickOptions).toEqual(undefined);
   });
 
   test("ignore custom option when config file is set", () => {
@@ -351,6 +358,7 @@ describe("cli args parser", () => {
     expect(args.squash).toEqual(true);
     expect(args.strategy).toEqual(undefined);
     expect(args.strategyOption).toEqual(undefined);
+    expect(args.cherryPickOptions).toEqual(undefined);
   });
 
   test("override squash to false", () => {
@@ -383,7 +391,7 @@ describe("cli args parser", () => {
     expect(args.squash).toEqual(false);
   });
 
-  test("override cherry pick strategies", () => {
+  test("override cherry pick strategies and options", () => {
     addProcessArgs([
       "--target-branch",
       "target",
@@ -393,6 +401,8 @@ describe("cli args parser", () => {
       "ort",
       "--strategy-option",
       "ours",
+      "--cherry-pick-options",
+      "--allow-empty -x",
     ]);
 
     const args: Args = parser.parse();
@@ -416,6 +426,7 @@ describe("cli args parser", () => {
     expect(args.squash).toEqual(true);
     expect(args.strategy).toEqual("ort");
     expect(args.strategyOption).toEqual("ours");
+    expect(args.cherryPickOptions).toEqual("--allow-empty -x");
   });
 
   test("additional pr comments", () => {
@@ -479,6 +490,7 @@ describe("cli args parser", () => {
     expect(args.squash).toEqual(true);
     expect(args.strategy).toEqual(undefined);
     expect(args.strategyOption).toEqual(undefined);
+    expect(args.cherryPickOptions).toEqual(undefined);
   });
 
   test("invalid execution with empty target branch", () => {

test/service/args/gha/gha-args-parser.test.ts

@@ -72,6 +72,7 @@ describe("gha args parser", () => {
     expect(args.squash).toEqual(true);
     expect(args.strategy).toEqual(undefined);
     expect(args.strategyOption).toEqual(undefined);
+    expect(args.cherryPickOptions).toEqual(undefined);
   });
 
   test("valid execution [override]", () => {
@@ -113,6 +114,7 @@ describe("gha args parser", () => {
     expect(args.squash).toEqual(true);
     expect(args.strategy).toEqual(undefined);
     expect(args.strategyOption).toEqual(undefined);
+    expect(args.cherryPickOptions).toEqual(undefined);
   });
 
   test("using config file", () => {
@@ -140,6 +142,7 @@ describe("gha args parser", () => {
     expect(args.squash).toEqual(true);
     expect(args.strategy).toEqual(undefined);
     expect(args.strategyOption).toEqual(undefined);
+    expect(args.cherryPickOptions).toEqual(undefined);
   });
 
   test("ignore custom options when using config file", () => {
@@ -182,6 +185,7 @@ describe("gha args parser", () => {
     expect(args.squash).toEqual(true);
     expect(args.strategy).toEqual(undefined);
     expect(args.strategyOption).toEqual(undefined);
+    expect(args.cherryPickOptions).toEqual(undefined);
   });
 
   test("override squash to false", () => {
@@ -235,6 +239,7 @@ describe("gha args parser", () => {
     expect(args.squash).toEqual(true);
     expect(args.strategy).toEqual("ort");
     expect(args.strategyOption).toEqual("ours");
+    expect(args.cherryPickOptions).toEqual(undefined);
   });
 
   test("additional pr comments", () => {
@@ -287,6 +292,7 @@ describe("gha args parser", () => {
     expect(args.squash).toEqual(true);
     expect(args.strategy).toEqual(undefined);
     expect(args.strategyOption).toEqual(undefined);
+    expect(args.cherryPickOptions).toEqual(undefined);
   });