feat(issue-17): override backporting pr data (#29)

src/service/args/args.types.ts

@@ -8,4 +8,8 @@ export interface Args {
   pullRequest: string, // url of the pull request to backport
   folder?: string, // local folder where the repositories should be cloned
   author?: string, // backport pr author, default taken from pr
+  title?: string, // backport pr title, default original pr title prefixed by target branch
+  body?: string, // backport pr title, default original pr body prefixed by bodyPrefix
+  bodyPrefix?: string, // backport pr body prefix, default `backport <original-pr-link>`
+  bpBranchName?: string, // backport pr branch name, default computed from commit
 }

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

@@ -14,7 +14,11 @@ export default class CLIArgsParser implements ArgsParser {
       .requiredOption("-pr, --pull-request <pr url>", "pull request url, e.g., https://github.com/lampajr/backporting/pull/1.")
       .option("-d, --dry-run", "if enabled the tool does not create any pull request nor push anything remotely", false)
       .option("-a, --auth <auth>", "git service authentication string, e.g., github token.", "")
-      .option("-f, --folder <folder>", "local folder where the repo will be checked out, e.g., /tmp/folder.", undefined);
+      .option("-f, --folder <folder>", "local folder where the repo will be checked out, e.g., /tmp/folder.", undefined)
+      .option("--title <folder>", "backport pr title, default original pr title prefixed by target branch.", undefined)
+      .option("--body <folder>", "backport pr title, default original pr body prefixed by bodyPrefix.", undefined)
+      .option("--body-prefix <folder>", "backport pr body prefix, default `backport <original-pr-link>`.", undefined)
+      .option("--bp-branch-name <folder>", "backport pr branch name, default auto-generated by the commit.", undefined);
   }
 
   parse(): Args {
@@ -27,7 +31,11 @@ export default class CLIArgsParser implements ArgsParser {
       auth: opts.auth,
       pullRequest: opts.pullRequest,
       targetBranch: opts.targetBranch,
-      folder: opts.folder
+      folder: opts.folder,
+      title: opts.title,
+      body: opts.body,
+      bodyPrefix: opts.bodyPrefix,
+      bpBranchName: opts.bpBranchName,
     };
   }
 

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

@@ -10,7 +10,11 @@ export default class GHAArgsParser implements ArgsParser {
       auth: getInput("auth") ? getInput("auth") : "",
       pullRequest: getInput("pull-request"),
       targetBranch: getInput("target-branch"),
-      folder: getInput("folder") !== "" ? getInput("folder") : undefined
+      folder: getInput("folder") !== "" ? getInput("folder") : undefined,
+      title: getInput("title"),
+      body: getInput("body"),
+      bodyPrefix: getInput("body-prefix"),
+      bpBranchName: getInput("bp-branch-name"),
     };
   }
 

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

@@ -25,7 +25,7 @@ export default class PullRequestConfigsParser extends ConfigsParser {
       folder: `${folder.startsWith("/") ? "" : process.cwd() + "/"}${args.folder ?? this.getDefaultFolder()}`,
       targetBranch: args.targetBranch,
       originalPullRequest: pr,
-      backportPullRequest: this.getDefaultBackportPullRequest(pr, args.targetBranch)
+      backportPullRequest: this.getDefaultBackportPullRequest(pr, args)
     };
   }
   
@@ -34,26 +34,30 @@ export default class PullRequestConfigsParser extends ConfigsParser {
   }
 
   /**
-   * Create a default backport pull request starting from the target branch and 
+   * Create a backport pull request starting from the target branch and 
    * the original pr to be backported
    * @param originalPullRequest original pull request
    * @param targetBranch target branch where the backport should be applied
    * @returns {GitPullRequest}
    */
-  private getDefaultBackportPullRequest(originalPullRequest: GitPullRequest, targetBranch: string): GitPullRequest {
+  private getDefaultBackportPullRequest(originalPullRequest: GitPullRequest, args: Args): GitPullRequest {
     const reviewers = [];
     reviewers.push(originalPullRequest.author);
     if (originalPullRequest.mergedBy) {
       reviewers.push(originalPullRequest.mergedBy);  
     }
 
+    const bodyPrefix = args.bodyPrefix ?? `**Backport:** ${originalPullRequest.htmlUrl}\r\n\r\n`;
+    const body = args.body ?? `${originalPullRequest.body}\r\n\r\nPowered by [BPer](https://github.com/lampajr/backporting).`;
+    
     return {
       author: originalPullRequest.author,
-      title: `[${targetBranch}] ${originalPullRequest.title}`, 
-      body: `**Backport:** ${originalPullRequest.htmlUrl}\r\n\r\n${originalPullRequest.body}\r\n\r\nPowered by [BPer](https://github.com/lampajr/backporting).`,
+      title: args.title ?? `[${args.targetBranch}] ${originalPullRequest.title}`, 
+      body: `${bodyPrefix}${body}`,
       reviewers: [...new Set(reviewers)],
       targetRepo: originalPullRequest.targetRepo,
       sourceRepo: originalPullRequest.targetRepo,
+      branchName: args.bpBranchName,
       nCommits: 0, // TODO: needed?
       commits: [] // TODO needed?
     };

src/service/git/git.types.ts

@@ -12,7 +12,8 @@ export interface GitPullRequest {
   targetRepo: GitRepository,
   sourceRepo: GitRepository,
   nCommits: number, // number of commits in the pr
-  commits: string[] // merge commit or last one
+  commits: string[], // merge commit or last one
+  branchName?: string,
 }
 
 export interface GitRepository {
@@ -28,7 +29,8 @@ export interface BackportPullRequest {
   base: string, // name of the target branch
   title: string, // pr title
   body: string, // pr body
-  reviewers: string[] // pr list of reviewers
+  reviewers: string[], // pr list of reviewers
+  branchName?: string,
 }
 
 export enum GitServiceType {

src/service/runner/runner.ts

@@ -86,7 +86,7 @@ export default class Runner {
     await git.clone(configs.originalPullRequest.targetRepo.cloneUrl, configs.folder, configs.targetBranch);
 
     // 5. create new branch from target one and checkout
-    const backportBranch = `bp-${configs.targetBranch}-${originalPR.commits.join("-")}`;
+    const backportBranch = backportPR.branchName ?? `bp-${configs.targetBranch}-${originalPR.commits.join("-")}`;
     await git.createLocalBranch(configs.folder, backportBranch);
 
     // 6. fetch pull request remote if source owner != target owner or pull request still open