feat(issue-70): additional pr comments

src/service/args/args-parser.ts

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

src/service/args/args-utils.ts

@@ -44,6 +44,12 @@ export function getAsCommaSeparatedList(value: string): string[] | undefined {
   return trimmed !== "" ? trimmed.split(",").map(v => v.trim()) : undefined; 
 }
 
+export function getAsSemicolonSeparatedList(value: string): string[] | undefined {
+  // trim the value
+  const trimmed: string = value.trim();
+  return trimmed !== "" ? trimmed.split(";").map(v => v.trim()) : undefined; 
+}
+
 export function getAsBooleanOrDefault(value: string): boolean | undefined {
   const trimmed = value.trim();
   return trimmed !== "" ? trimmed.toLowerCase() === "true" : undefined;

src/service/args/args.types.ts

@@ -21,4 +21,5 @@ 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
+  comments?: string[], // additional comments to be posted
 }

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

@@ -2,7 +2,7 @@ import ArgsParser from "@bp/service/args/args-parser";
 import { Args } from "@bp/service/args/args.types";
 import { Command } from "commander";
 import { name, version, description } from "@bp/../package.json";
-import { getAsCleanedCommaSeparatedList, getAsCommaSeparatedList, readConfigFile } from "@bp/service/args/args-utils";
+import { getAsCleanedCommaSeparatedList, getAsCommaSeparatedList, getAsSemicolonSeparatedList, readConfigFile } from "@bp/service/args/args-utils";
 
 export default class CLIArgsParser extends ArgsParser {
 
@@ -29,6 +29,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("--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");
   }
 
@@ -62,6 +63,7 @@ export default class CLIArgsParser extends ArgsParser {
         squash: opts.squash,
         strategy: opts.strategy,
         strategyOption: opts.strategyOption,
+        comments: opts.comments,
       };
     }
 

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

@@ -1,7 +1,7 @@
 import ArgsParser from "@bp/service/args/args-parser";
 import { Args } from "@bp/service/args/args.types";
 import { getInput } from "@actions/core";
-import { getAsBooleanOrDefault, getAsCleanedCommaSeparatedList, getAsCommaSeparatedList, getOrUndefined, readConfigFile } from "@bp/service/args/args-utils";
+import { getAsBooleanOrDefault, getAsCleanedCommaSeparatedList, getAsCommaSeparatedList, getAsSemicolonSeparatedList, getOrUndefined, readConfigFile } from "@bp/service/args/args-utils";
 
 export default class GHAArgsParser extends ArgsParser {
 
@@ -32,6 +32,7 @@ export default class GHAArgsParser extends ArgsParser {
         squash: !getAsBooleanOrDefault(getInput("no-squash")),
         strategy: getOrUndefined(getInput("strategy")),
         strategyOption: getOrUndefined(getInput("strategy-option")),
+        comments: getAsSemicolonSeparatedList(getInput("comments")),
       };
     }
 

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

@@ -92,7 +92,7 @@ export default class PullRequestConfigsParser extends ConfigsParser {
       reviewers: [...new Set(reviewers)],
       assignees: [...new Set(args.assignees)],
       labels: [...new Set(labels)],
-      comments: [], // TODO fix comments
+      comments: args.comments ?? [],
     };
   }
 }

src/service/git/github/github-client.ts

@@ -117,6 +117,19 @@ export default class GitHubClient implements GitClient {
       );
     }
 
+    if (backport.comments.length > 0) {
+      backport.comments.forEach(c => {
+        promises.push(
+          this.octokit.issues.createComment({
+            owner: backport.owner,
+            repo: backport.repo,
+            issue_number: (data as PullRequest).number,
+            body: c,
+          }).catch(error => this.logger.error(`Error posting comment: ${error}`))
+        );
+      });
+    }
+
     await Promise.all(promises);
 
     return data.html_url;

src/service/git/gitlab/gitlab-client.ts

@@ -96,6 +96,18 @@ export default class GitLabClient implements GitClient {
       );
     }
 
+    // comments
+    if (backport.comments.length > 0) {
+      this.logger.info("Posting comments: " + backport.comments);
+      backport.comments.forEach(c => {
+        promises.push(
+          this.client.post(`/projects/${projectId}/merge_requests/${mr.iid}/notes`, {
+            body: c,
+          }).catch(error => this.logger.warn("Failure trying to post comment. " + error))
+        );
+      });
+    }
+
     // reviewers
     const reviewerIds = await Promise.all(backport.reviewers.map(async r => {
       this.logger.debug("Retrieving user: " + r);