refactor: move backport data generation to configs parser

dist/cli/index.js

@@ -336,16 +336,27 @@ class PullRequestConfigsParser extends configs_parser_1.default {
         if (args.inheritLabels) {
             labels.push(...originalPullRequest.labels);
         }
+        let backportBranch = args.bpBranchName;
+        if (backportBranch === undefined || backportBranch.trim() === "") {
+            // for each commit takes the first 7 chars that are enough to uniquely identify them in most of the projects
+            const concatenatedCommits = originalPullRequest.commits.map(c => c.slice(0, 7)).join("-");
+            backportBranch = `bp-${args.targetBranch}-${concatenatedCommits}`;
+        }
+        if (backportBranch.length > 250) {
+            this.logger.warn(`Backport branch (length=${backportBranch.length}) exceeded the max length of 250 chars, branch name truncated!`);
+            backportBranch = backportBranch.slice(0, 250);
+        }
         return {
-            author: args.gitUser ?? this.gitClient.getDefaultGitUser(),
+            owner: originalPullRequest.targetRepo.owner,
+            repo: originalPullRequest.targetRepo.project,
+            head: backportBranch,
+            base: args.targetBranch,
             title: args.title ?? `[${args.targetBranch}] ${originalPullRequest.title}`,
             body: `${bodyPrefix}${body}`,
             reviewers: [...new Set(reviewers)],
             assignees: [...new Set(args.assignees)],
             labels: [...new Set(labels)],
-            targetRepo: originalPullRequest.targetRepo,
+            comments: [], // TODO fix comments
-            sourceRepo: originalPullRequest.targetRepo,
-            branchName: args.bpBranchName,
         };
     }
 }
@@ -1211,17 +1222,7 @@ class Runner {
         await git.clone(configs.originalPullRequest.targetRepo.cloneUrl, configs.folder, configs.targetBranch);
         // 5. create new branch from target one and checkout
         this.logger.debug("Creating local branch..");
-        let backportBranch = backportPR.branchName;
+        await git.createLocalBranch(configs.folder, backportPR.head);
-        if (backportBranch === undefined || backportBranch.trim() === "") {
-            // for each commit takes the first 7 chars that are enough to uniquely identify them in most of the projects
-            const concatenatedCommits = originalPR.commits.map(c => c.slice(0, 7)).join("-");
-            backportBranch = `bp-${configs.targetBranch}-${concatenatedCommits}`;
-        }
-        if (backportBranch.length > 250) {
-            this.logger.warn(`Backport branch (length=${backportBranch.length}) exceeded the max length of 250 chars, branch name truncated!`);
-            backportBranch = backportBranch.slice(0, 250);
-        }
-        await git.createLocalBranch(configs.folder, backportBranch);
         // 6. fetch pull request remote if source owner != target owner or pull request still open
         if (configs.originalPullRequest.sourceRepo.owner !== configs.originalPullRequest.targetRepo.owner ||
             configs.originalPullRequest.state === "open") {
@@ -1234,27 +1235,16 @@ class Runner {
         for (const sha of originalPR.commits) {
             await git.cherryPick(configs.folder, sha, configs.mergeStrategy, configs.mergeStrategyOption);
         }
-        const backport = {
-            owner: originalPR.targetRepo.owner,
-            repo: originalPR.targetRepo.project,
-            head: backportBranch,
-            base: configs.targetBranch,
-            title: backportPR.title,
-            body: backportPR.body,
-            reviewers: backportPR.reviewers,
-            assignees: backportPR.assignees,
-            labels: backportPR.labels,
-        };
         if (!configs.dryRun) {
             // 8. push the new branch to origin
-            await git.push(configs.folder, backportBranch);
+            await git.push(configs.folder, backportPR.head);
             // 9. create pull request new branch -> target branch (using octokit)
-            const prUrl = await gitApi.createPullRequest(backport);
+            const prUrl = await gitApi.createPullRequest(backportPR);
             this.logger.info(`Pull request created: ${prUrl}`);
         }
         else {
             this.logger.warn("Pull request creation and remote push skipped");
-            this.logger.info(`${JSON.stringify(backport, null, 2)}`);
+            this.logger.info(`${JSON.stringify(backportPR, null, 2)}`);
         }
     }
 }

dist/gha/index.js

@@ -307,16 +307,27 @@ class PullRequestConfigsParser extends configs_parser_1.default {
         if (args.inheritLabels) {
             labels.push(...originalPullRequest.labels);
         }
+        let backportBranch = args.bpBranchName;
+        if (backportBranch === undefined || backportBranch.trim() === "") {
+            // for each commit takes the first 7 chars that are enough to uniquely identify them in most of the projects
+            const concatenatedCommits = originalPullRequest.commits.map(c => c.slice(0, 7)).join("-");
+            backportBranch = `bp-${args.targetBranch}-${concatenatedCommits}`;
+        }
+        if (backportBranch.length > 250) {
+            this.logger.warn(`Backport branch (length=${backportBranch.length}) exceeded the max length of 250 chars, branch name truncated!`);
+            backportBranch = backportBranch.slice(0, 250);
+        }
         return {
-            author: args.gitUser ?? this.gitClient.getDefaultGitUser(),
+            owner: originalPullRequest.targetRepo.owner,
+            repo: originalPullRequest.targetRepo.project,
+            head: backportBranch,
+            base: args.targetBranch,
             title: args.title ?? `[${args.targetBranch}] ${originalPullRequest.title}`,
             body: `${bodyPrefix}${body}`,
             reviewers: [...new Set(reviewers)],
             assignees: [...new Set(args.assignees)],
             labels: [...new Set(labels)],
-            targetRepo: originalPullRequest.targetRepo,
+            comments: [], // TODO fix comments
-            sourceRepo: originalPullRequest.targetRepo,
-            branchName: args.bpBranchName,
         };
     }
 }
@@ -1182,17 +1193,7 @@ class Runner {
         await git.clone(configs.originalPullRequest.targetRepo.cloneUrl, configs.folder, configs.targetBranch);
         // 5. create new branch from target one and checkout
         this.logger.debug("Creating local branch..");
-        let backportBranch = backportPR.branchName;
+        await git.createLocalBranch(configs.folder, backportPR.head);
-        if (backportBranch === undefined || backportBranch.trim() === "") {
-            // for each commit takes the first 7 chars that are enough to uniquely identify them in most of the projects
-            const concatenatedCommits = originalPR.commits.map(c => c.slice(0, 7)).join("-");
-            backportBranch = `bp-${configs.targetBranch}-${concatenatedCommits}`;
-        }
-        if (backportBranch.length > 250) {
-            this.logger.warn(`Backport branch (length=${backportBranch.length}) exceeded the max length of 250 chars, branch name truncated!`);
-            backportBranch = backportBranch.slice(0, 250);
-        }
-        await git.createLocalBranch(configs.folder, backportBranch);
         // 6. fetch pull request remote if source owner != target owner or pull request still open
         if (configs.originalPullRequest.sourceRepo.owner !== configs.originalPullRequest.targetRepo.owner ||
             configs.originalPullRequest.state === "open") {
@@ -1205,27 +1206,16 @@ class Runner {
         for (const sha of originalPR.commits) {
             await git.cherryPick(configs.folder, sha, configs.mergeStrategy, configs.mergeStrategyOption);
         }
-        const backport = {
-            owner: originalPR.targetRepo.owner,
-            repo: originalPR.targetRepo.project,
-            head: backportBranch,
-            base: configs.targetBranch,
-            title: backportPR.title,
-            body: backportPR.body,
-            reviewers: backportPR.reviewers,
-            assignees: backportPR.assignees,
-            labels: backportPR.labels,
-        };
         if (!configs.dryRun) {
             // 8. push the new branch to origin
-            await git.push(configs.folder, backportBranch);
+            await git.push(configs.folder, backportPR.head);
             // 9. create pull request new branch -> target branch (using octokit)
-            const prUrl = await gitApi.createPullRequest(backport);
+            const prUrl = await gitApi.createPullRequest(backportPR);
             this.logger.info(`Pull request created: ${prUrl}`);
         }
         else {
             this.logger.warn("Pull request creation and remote push skipped");
-            this.logger.info(`${JSON.stringify(backport, null, 2)}`);
+            this.logger.info(`${JSON.stringify(backportPR, null, 2)}`);
         }
     }
 }

src/service/configs/configs.types.ts

@@ -1,6 +1,6 @@
 
 
-import { GitPullRequest } from "@bp/service/git/git.types";
+import { BackportPullRequest, GitPullRequest } from "@bp/service/git/git.types";
 
 export interface LocalGit {
   user: string, // local git user
@@ -19,6 +19,6 @@ export interface Configs {
   mergeStrategy?: string, // cherry-pick merge strategy
   mergeStrategyOption?: string, // cherry-pick merge strategy option
   originalPullRequest: GitPullRequest,
-  backportPullRequest: GitPullRequest,
+  backportPullRequest: BackportPullRequest,
  }
 

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

@@ -3,7 +3,7 @@ import ConfigsParser from "@bp/service/configs/configs-parser";
 import { Configs } from "@bp/service/configs/configs.types";
 import GitClient from "@bp/service/git/git-client";
 import GitClientFactory from "@bp/service/git/git-client-factory";
-import { GitPullRequest } from "@bp/service/git/git.types";
+import { BackportPullRequest, GitPullRequest } from "@bp/service/git/git.types";
 
 export default class PullRequestConfigsParser extends ConfigsParser {
 
@@ -52,7 +52,7 @@ export default class PullRequestConfigsParser extends ConfigsParser {
    * @param targetBranch target branch where the backport should be applied
    * @returns {GitPullRequest}
    */
-  private getDefaultBackportPullRequest(originalPullRequest: GitPullRequest, args: Args): GitPullRequest {
+  private getDefaultBackportPullRequest(originalPullRequest: GitPullRequest, args: Args): BackportPullRequest {
     const reviewers = args.reviewers ?? [];
     if (reviewers.length == 0 && args.inheritReviewers) {
       // inherit only if args.reviewers is empty and args.inheritReviewers set to true
@@ -70,16 +70,29 @@ export default class PullRequestConfigsParser extends ConfigsParser {
       labels.push(...originalPullRequest.labels);
     }
 
+    let backportBranch = args.bpBranchName;
+    if (backportBranch === undefined || backportBranch.trim() === "") {
+      // for each commit takes the first 7 chars that are enough to uniquely identify them in most of the projects
+      const concatenatedCommits: string = originalPullRequest.commits!.map(c => c.slice(0, 7)).join("-");
+      backportBranch = `bp-${args.targetBranch}-${concatenatedCommits}`;
+    }
+
+    if (backportBranch.length > 250) {
+      this.logger.warn(`Backport branch (length=${backportBranch.length}) exceeded the max length of 250 chars, branch name truncated!`);
+      backportBranch = backportBranch.slice(0, 250);
+    }
+
     return {
-      author: args.gitUser ?? this.gitClient.getDefaultGitUser(),
+      owner: originalPullRequest.targetRepo.owner,
+      repo: originalPullRequest.targetRepo.project,
+      head: backportBranch,
+      base: args.targetBranch,
       title: args.title ?? `[${args.targetBranch}] ${originalPullRequest.title}`, 
       body: `${bodyPrefix}${body}`,
       reviewers: [...new Set(reviewers)],
       assignees: [...new Set(args.assignees)],
       labels: [...new Set(labels)],
-      targetRepo: originalPullRequest.targetRepo,
+      comments: [], // TODO fix comments
-      sourceRepo: originalPullRequest.targetRepo,
-      branchName: args.bpBranchName,
     };
   }
 }

src/service/git/git-client.ts

@@ -38,4 +38,5 @@ import { BackportPullRequest, GitPullRequest } from "@bp/service/git/git.types";
    * @returns {Promise<string>} the pull request url
    */
   createPullRequest(backport: BackportPullRequest): Promise<string>;
+
 }

src/service/git/git.types.ts

@@ -13,8 +13,8 @@ export interface GitPullRequest {
   labels: string[],
   targetRepo: GitRepository,
   sourceRepo: GitRepository,
-  nCommits?: number, // number of commits in the pr
+  nCommits: number, // number of commits in the pr
-  commits?: string[], // merge commit or last one
+  commits: string[], // merge commit or last one
   branchName?: string,
 }
 
@@ -34,7 +34,8 @@ export interface BackportPullRequest {
   reviewers: string[], // pr list of reviewers
   assignees: string[], // pr list of assignees
   labels: string[], // pr list of assigned labels
-  branchName?: string,
+  comments: string[], // pr list of additional comments
+  // branchName?: string,
 }
 
 export enum GitClientType {

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

@@ -141,7 +141,6 @@ export default class GitLabClient implements GitClient {
     return mr.web_url;
   }
 
-
   /**
    * Retrieve a gitlab user given its username
    * @param username 

src/service/runner/runner.ts

@@ -63,7 +63,7 @@ export default class Runner {
     this.logger.debug("Parsing configs..");
     const configs: Configs = await new PullRequestConfigsParser().parseAndValidate(args);
     const originalPR: GitPullRequest = configs.originalPullRequest;
-    const backportPR: GitPullRequest = configs.backportPullRequest;
+    const backportPR: BackportPullRequest = configs.backportPullRequest;
 
     // start local git operations
     const git: GitCLIService = new GitCLIService(configs.auth, configs.git);
@@ -74,19 +74,8 @@ export default class Runner {
 
     // 5. create new branch from target one and checkout
     this.logger.debug("Creating local branch..");
-    let backportBranch = backportPR.branchName;
-    if (backportBranch === undefined || backportBranch.trim() === "") {
-      // for each commit takes the first 7 chars that are enough to uniquely identify them in most of the projects
-      const concatenatedCommits: string = originalPR.commits!.map(c => c.slice(0, 7)).join("-");
-      backportBranch = `bp-${configs.targetBranch}-${concatenatedCommits}`;
-    }
 
-    if (backportBranch.length > 250) {
+    await git.createLocalBranch(configs.folder, backportPR.head);
-      this.logger.warn(`Backport branch (length=${backportBranch.length}) exceeded the max length of 250 chars, branch name truncated!`);
-      backportBranch = backportBranch.slice(0, 250);
-    }
-
-    await git.createLocalBranch(configs.folder, backportBranch);
 
     // 6. fetch pull request remote if source owner != target owner or pull request still open
     if (configs.originalPullRequest.sourceRepo.owner !== configs.originalPullRequest.targetRepo.owner || 
@@ -102,29 +91,17 @@ export default class Runner {
       await git.cherryPick(configs.folder, sha, configs.mergeStrategy, configs.mergeStrategyOption);
     }
 
-    const backport: BackportPullRequest = {
-      owner: originalPR.targetRepo.owner,
-      repo: originalPR.targetRepo.project,
-      head: backportBranch,
-      base: configs.targetBranch,
-      title: backportPR.title,
-      body: backportPR.body,
-      reviewers: backportPR.reviewers,
-      assignees: backportPR.assignees,
-      labels: backportPR.labels,
-    };
-
     if (!configs.dryRun) {
       // 8. push the new branch to origin
-      await git.push(configs.folder, backportBranch);
+      await git.push(configs.folder, backportPR.head);
 
       // 9. create pull request new branch -> target branch (using octokit)
-      const prUrl = await gitApi.createPullRequest(backport);
+      const prUrl = await gitApi.createPullRequest(backportPR);
       this.logger.info(`Pull request created: ${prUrl}`);
 
     } else {
       this.logger.warn("Pull request creation and remote push skipped");
-      this.logger.info(`${JSON.stringify(backport, null, 2)}`);
+      this.logger.info(`${JSON.stringify(backportPR, null, 2)}`);
     }
   }
 

test/service/configs/pullrequest/github-pr-configs-parser.test.ts

@@ -129,25 +129,16 @@ describe("github pull request config parser", () => {
       commits: ["28f63db774185f4ec4b57cd9aaeb12dbfb4c9ecc"]
     });
     expect(configs.backportPullRequest).toEqual({
-      author: "GitHub",
+      owner: "owner", 
-      url: undefined,
+      repo: "reponame", 
-      htmlUrl: undefined,
+      head: "bp-prod-28f63db", 
-      title: "[prod] PR Title",
+      base: "prod", 
+      title: "[prod] PR Title", 
       body: "**Backport:** https://github.com/owner/reponame/pull/2368\r\n\r\nPlease review and merge",
       reviewers: ["gh-user", "that-s-a-user"],
       assignees: [],
       labels: [],
-      targetRepo: {
+      comments: [],
-        owner: "owner",
-        project: "reponame",
-        cloneUrl: "https://github.com/owner/reponame.git"
-      },
-      sourceRepo: {
-        owner: "owner",
-        project: "reponame",
-        cloneUrl: "https://github.com/owner/reponame.git"
-      },
-      bpBranchName: undefined,
     });
   });
 
@@ -264,6 +255,7 @@ describe("github pull request config parser", () => {
       reviewers: [],
       assignees: [],
       inheritReviewers: true,
+      bpBranchName: "custom-branch"
     };
 
     const configs: Configs = await configParser.parseAndValidate(args);
@@ -309,25 +301,16 @@ describe("github pull request config parser", () => {
       commits: ["28f63db774185f4ec4b57cd9aaeb12dbfb4c9ecc"],
     });
     expect(configs.backportPullRequest).toEqual({
-      author: "Me",
+      owner: "owner", 
-      url: undefined,
+      repo: "reponame", 
-      htmlUrl: undefined,
+      head: "custom-branch", 
+      base: "prod", 
       title: "New Title",
       body: "New Body Prefix -New Body",
       reviewers: ["gh-user", "that-s-a-user"],
       assignees: [],
       labels: [],
-      targetRepo: {
+      comments: [],
-        owner: "owner",
-        project: "reponame",
-        cloneUrl: "https://github.com/owner/reponame.git"
-      },
-      sourceRepo: {
-        owner: "owner",
-        project: "reponame",
-        cloneUrl: "https://github.com/owner/reponame.git"
-      },
-      bpBranchName: undefined,
     });
   });
 
@@ -390,25 +373,16 @@ describe("github pull request config parser", () => {
       commits: ["28f63db774185f4ec4b57cd9aaeb12dbfb4c9ecc"],
     });
     expect(configs.backportPullRequest).toEqual({
-      author: "Me",
+      owner: "owner", 
-      url: undefined,
+      repo: "reponame", 
-      htmlUrl: undefined,
+      head: "bp-prod-28f63db", 
+      base: "prod", 
       title: "New Title",
       body: "New Body Prefix -New Body",
       reviewers: ["user1", "user2"],
       assignees: ["user3", "user4"],
       labels: [],
-      targetRepo: {
+      comments: [],
-        owner: "owner",
-        project: "reponame",
-        cloneUrl: "https://github.com/owner/reponame.git"
-      },
-      sourceRepo: {
-        owner: "owner",
-        project: "reponame",
-        cloneUrl: "https://github.com/owner/reponame.git"
-      },
-      bpBranchName: undefined,
     });
   });
 
@@ -471,25 +445,16 @@ describe("github pull request config parser", () => {
       commits: ["28f63db774185f4ec4b57cd9aaeb12dbfb4c9ecc"],
     });
     expect(configs.backportPullRequest).toEqual({
-      author: "Me",
+      owner: "owner", 
-      url: undefined,
+      repo: "reponame", 
-      htmlUrl: undefined,
+      head: "bp-prod-28f63db", 
+      base: "prod", 
       title: "New Title",
       body: "New Body Prefix -New Body",
       reviewers: [],
       assignees: ["user3", "user4"],
       labels: [],
-      targetRepo: {
+      comments: [],
-        owner: "owner",
-        project: "reponame",
-        cloneUrl: "https://github.com/owner/reponame.git"
-      },
-      sourceRepo: {
-        owner: "owner",
-        project: "reponame",
-        cloneUrl: "https://github.com/owner/reponame.git"
-      },
-      bpBranchName: undefined,
     });
   });
 
@@ -554,25 +519,16 @@ describe("github pull request config parser", () => {
       commits: ["28f63db774185f4ec4b57cd9aaeb12dbfb4c9ecc"],
     });
     expect(configs.backportPullRequest).toEqual({
-      author: "Me",
+      owner: "owner", 
-      url: undefined,
+      repo: "reponame", 
-      htmlUrl: undefined,
+      head: "bp-prod-28f63db", 
+      base: "prod", 
       title: "New Title",
       body: "New Body Prefix -New Body",
       reviewers: [],
       assignees: ["user3", "user4"],
       labels: ["custom-label", "original-label"],
-      targetRepo: {
+      comments: [],
-        owner: "owner",
-        project: "reponame",
-        cloneUrl: "https://github.com/owner/reponame.git"
-      },
-      sourceRepo: {
-        owner: "owner",
-        project: "reponame",
-        cloneUrl: "https://github.com/owner/reponame.git"
-      },
-      bpBranchName: undefined,
     });
   });
   
@@ -625,25 +581,16 @@ describe("github pull request config parser", () => {
       commits: ["28f63db774185f4ec4b57cd9aaeb12dbfb4c9ecc"]
     });
     expect(configs.backportPullRequest).toEqual({
-      author: "GitHub",
+      owner: "owner", 
-      url: undefined,
+      repo: "reponame",
-      htmlUrl: undefined,
+      head: "bp-prod-28f63db",
+      base: "prod",
       title: "[prod] PR Title",
       body: "**Backport:** https://github.com/owner/reponame/pull/2368\r\n\r\nPlease review and merge",
       reviewers: ["gh-user", "that-s-a-user"],
       assignees: [],
       labels: [],
-      targetRepo: {
+      comments: [],
-        owner: "owner",
-        project: "reponame",
-        cloneUrl: "https://github.com/owner/reponame.git"
-      },
-      sourceRepo: {
-        owner: "owner",
-        project: "reponame",
-        cloneUrl: "https://github.com/owner/reponame.git"
-      },
-      bpBranchName: undefined,
     });
   });
 
@@ -697,25 +644,16 @@ describe("github pull request config parser", () => {
       commits: ["28f63db774185f4ec4b57cd9aaeb12dbfb4c9ecc"],
     });
     expect(configs.backportPullRequest).toEqual({
-      author: "Me",
+      owner: "owner", 
-      url: undefined,
+      repo: "reponame",
-      htmlUrl: undefined,
+      head: "bp-prod-28f63db",
+      base: "prod",
       title: "New Title",
       body: "New Body Prefix -New Body",
       reviewers: ["user1", "user2"],
       assignees: ["user3", "user4"],
       labels: ["cherry-pick :cherries:", "original-label"],
-      targetRepo: {
+      comments: [],
-        owner: "owner",
-        project: "reponame",
-        cloneUrl: "https://github.com/owner/reponame.git"
-      },
-      sourceRepo: {
-        owner: "owner",
-        project: "reponame",
-        cloneUrl: "https://github.com/owner/reponame.git"
-      },
-      bpBranchName: undefined,
     });
   });
 
@@ -775,25 +713,16 @@ describe("github pull request config parser", () => {
       commits: ["0404fb922ab75c3a8aecad5c97d9af388df04695", "11da4e38aa3e577ffde6d546f1c52e53b04d3151"]
     });
     expect(configs.backportPullRequest).toEqual({
-      author: "GitHub",
+      owner: "owner", 
-      url: undefined,
+      repo: "reponame",
-      htmlUrl: undefined,
+      head: "bp-prod-0404fb9-11da4e3",
+      base: "prod",
       title: "[prod] PR Title",
       body: "**Backport:** https://github.com/owner/reponame/pull/8632\r\n\r\nPlease review and merge",
       reviewers: ["gh-user", "that-s-a-user"],
       assignees: [],
       labels: [],
-      targetRepo: {
+      comments: [],
-        owner: "owner",
-        project: "reponame",
-        cloneUrl: "https://github.com/owner/reponame.git"
-      },
-      sourceRepo: {
-        owner: "owner",
-        project: "reponame",
-        cloneUrl: "https://github.com/owner/reponame.git"
-      },
-      bpBranchName: undefined,
     });
   });
 });

test/service/configs/pullrequest/gitlab-pr-configs-parser.test.ts

@@ -129,25 +129,16 @@ describe("gitlab merge request config parser", () => {
       commits: ["ebb1eca696c42fd067658bd9b5267709f78ef38e"]
     });
     expect(configs.backportPullRequest).toEqual({
-      author: "Gitlab",
+      owner: "superuser", 
-      url: undefined,
+      repo: "backporting-example", 
-      htmlUrl: undefined,
+      head: "bp-prod-ebb1eca", 
+      base: "prod",
       title: "[prod] Update test.txt",
       body: "**Backport:** https://my.gitlab.host.com/superuser/backporting-example/-/merge_requests/1\r\n\r\nThis is the body",
       reviewers: ["superuser"],
       assignees: [],
       labels: [],
-      targetRepo: {
+      comments: [],
-        owner: "superuser",
-        project: "backporting-example",
-        cloneUrl: "https://my.gitlab.host.com/superuser/backporting-example.git"
-      },
-      sourceRepo: {
-        owner: "superuser",
-        project: "backporting-example",
-        cloneUrl: "https://my.gitlab.host.com/superuser/backporting-example.git"
-      },
-      bpBranchName: undefined,
     });
   });
 
@@ -314,25 +305,16 @@ describe("gitlab merge request config parser", () => {
       commits: ["ebb1eca696c42fd067658bd9b5267709f78ef38e"]
     });
     expect(configs.backportPullRequest).toEqual({
-      author: "Me",
+      owner: "superuser", 
-      url: undefined,
+      repo: "backporting-example", 
-      htmlUrl: undefined,
+      head: "bp-prod-ebb1eca", 
+      base: "prod",
       title: "New Title",
       body: "New Body Prefix -New Body",
       reviewers: ["superuser"],
       assignees: [],
       labels: [],
-      targetRepo: {
+      comments: [],
-        owner: "superuser",
-        project: "backporting-example",
-        cloneUrl: "https://my.gitlab.host.com/superuser/backporting-example.git"
-      },
-      sourceRepo: {
-        owner: "superuser",
-        project: "backporting-example",
-        cloneUrl: "https://my.gitlab.host.com/superuser/backporting-example.git"
-      },
-      bpBranchName: undefined,
     });
   });
 
@@ -394,25 +376,16 @@ describe("gitlab merge request config parser", () => {
       commits: ["ebb1eca696c42fd067658bd9b5267709f78ef38e"]
     });
     expect(configs.backportPullRequest).toEqual({
-      author: "Me",
+      owner: "superuser", 
-      url: undefined,
+      repo: "backporting-example", 
-      htmlUrl: undefined,
+      head: "bp-prod-ebb1eca", 
+      base: "prod",
       title: "New Title",
       body: "New Body Prefix -New Body",
       reviewers: ["user1", "user2"],
       assignees: ["user3", "user4"],
       labels: [],
-      targetRepo: {
+      comments: [],
-        owner: "superuser",
-        project: "backporting-example",
-        cloneUrl: "https://my.gitlab.host.com/superuser/backporting-example.git"
-      },
-      sourceRepo: {
-        owner: "superuser",
-        project: "backporting-example",
-        cloneUrl: "https://my.gitlab.host.com/superuser/backporting-example.git"
-      },
-      bpBranchName: undefined,
     });
   });
 
@@ -474,25 +447,16 @@ describe("gitlab merge request config parser", () => {
       commits: ["ebb1eca696c42fd067658bd9b5267709f78ef38e"]
     });
     expect(configs.backportPullRequest).toEqual({
-      author: "Me",
+      owner: "superuser", 
-      url: undefined,
+      repo: "backporting-example", 
-      htmlUrl: undefined,
+      head: "bp-prod-ebb1eca", 
+      base: "prod",
       title: "New Title",
       body: "New Body Prefix -New Body",
       reviewers: [],
       assignees: ["user3", "user4"],
       labels: [],
-      targetRepo: {
+      comments: [],
-        owner: "superuser",
-        project: "backporting-example",
-        cloneUrl: "https://my.gitlab.host.com/superuser/backporting-example.git"
-      },
-      sourceRepo: {
-        owner: "superuser",
-        project: "backporting-example",
-        cloneUrl: "https://my.gitlab.host.com/superuser/backporting-example.git"
-      },
-      bpBranchName: undefined,
     });
   });
 
@@ -556,25 +520,16 @@ describe("gitlab merge request config parser", () => {
       commits: ["ebb1eca696c42fd067658bd9b5267709f78ef38e"]
     });
     expect(configs.backportPullRequest).toEqual({
-      author: "Me",
+      owner: "superuser", 
-      url: undefined,
+      repo: "backporting-example", 
-      htmlUrl: undefined,
+      head: "bp-prod-ebb1eca", 
+      base: "prod",
       title: "New Title",
       body: "New Body Prefix -New Body",
       reviewers: [],
       assignees: ["user3", "user4"],
       labels: ["custom-label", "gitlab-original-label"],
-      targetRepo: {
+      comments: [],
-        owner: "superuser",
-        project: "backporting-example",
-        cloneUrl: "https://my.gitlab.host.com/superuser/backporting-example.git"
-      },
-      sourceRepo: {
-        owner: "superuser",
-        project: "backporting-example",
-        cloneUrl: "https://my.gitlab.host.com/superuser/backporting-example.git"
-      },
-      bpBranchName: undefined,
     });
   });
     
@@ -626,25 +581,16 @@ describe("gitlab merge request config parser", () => {
       commits: ["ebb1eca696c42fd067658bd9b5267709f78ef38e"]
     });
     expect(configs.backportPullRequest).toEqual({
-      author: "Gitlab",
+      owner: "superuser", 
-      url: undefined,
+      repo: "backporting-example", 
-      htmlUrl: undefined,
+      head: "bp-prod-ebb1eca", 
+      base: "prod",
       title: "[prod] Update test.txt",
       body: "**Backport:** https://my.gitlab.host.com/superuser/backporting-example/-/merge_requests/1\r\n\r\nThis is the body",
       reviewers: ["superuser"],
       assignees: [],
       labels: [],
-      targetRepo: {
+      comments: [],
-        owner: "superuser",
-        project: "backporting-example",
-        cloneUrl: "https://my.gitlab.host.com/superuser/backporting-example.git"
-      },
-      sourceRepo: {
-        owner: "superuser",
-        project: "backporting-example",
-        cloneUrl: "https://my.gitlab.host.com/superuser/backporting-example.git"
-      },
-      bpBranchName: undefined,
     });
   });
 
@@ -696,25 +642,16 @@ describe("gitlab merge request config parser", () => {
       commits: ["ebb1eca696c42fd067658bd9b5267709f78ef38e"]
     });
     expect(configs.backportPullRequest).toEqual({
-      author: "Me",
+      owner: "superuser", 
-      url: undefined,
+      repo: "backporting-example", 
-      htmlUrl: undefined,
+      head: "bp-prod-ebb1eca", 
+      base: "prod",
       title: "New Title",
       body: "New Body Prefix -New Body",
       reviewers: [],
       assignees: ["user3", "user4"],
       labels: ["cherry-pick :cherries:", "gitlab-original-label"],
-      targetRepo: {
+      comments: [],
-        owner: "superuser",
-        project: "backporting-example",
-        cloneUrl: "https://my.gitlab.host.com/superuser/backporting-example.git"
-      },
-      sourceRepo: {
-        owner: "superuser",
-        project: "backporting-example",
-        cloneUrl: "https://my.gitlab.host.com/superuser/backporting-example.git"
-      },
-      bpBranchName: undefined,
     });
   });
 
@@ -773,5 +710,17 @@ describe("gitlab merge request config parser", () => {
       nCommits: 2,
       commits: ["e4dd336a4a20f394df6665994df382fb1d193a11", "974519f65c9e0ed65277cd71026657a09fca05e7"]
     });
+    expect(configs.backportPullRequest).toEqual({
+      owner: "superuser", 
+      repo: "backporting-example", 
+      head: "bp-prod-e4dd336-974519f", 
+      base: "prod",
+      title: "[prod] Update test.txt opened",
+      body: "**Backport:** https://my.gitlab.host.com/superuser/backporting-example/-/merge_requests/2\r\n\r\nStill opened mr body",
+      reviewers: ["superuser"],
+      assignees: [],
+      labels: [],
+      comments: [],
+    });
   });
 });

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

@@ -89,6 +89,7 @@ describe("github service", () => {
       reviewers: [],
       assignees: [],
       labels: [],
+      comments: [],
     };
     
     const url: string = await gitClient.createPullRequest(backport);
@@ -119,6 +120,7 @@ describe("github service", () => {
       reviewers: ["superuser", "invalid"],
       assignees: [],
       labels: [],
+      comments: [],
     };
     
     const url: string = await gitClient.createPullRequest(backport);
@@ -154,6 +156,7 @@ describe("github service", () => {
       reviewers: [],
       assignees: ["superuser", "invalid"],
       labels: [],
+      comments: [],
     };
     
     const url: string = await gitClient.createPullRequest(backport);
@@ -189,6 +192,7 @@ describe("github service", () => {
       reviewers: ["superuser", "invalid"],
       assignees: [],
       labels: [],
+      comments: [],
     };
     
     const url: string = await gitClient.createPullRequest(backport);
@@ -224,6 +228,7 @@ describe("github service", () => {
       reviewers: [],
       assignees: ["superuser", "invalid"],
       labels: [],
+      comments: [],
     };
     
     const url: string = await gitClient.createPullRequest(backport);
@@ -259,6 +264,7 @@ describe("github service", () => {
       reviewers: [],
       assignees: [],
       labels: ["label1", "label2"],
+      comments: [],
     };
     
     const url: string = await gitClient.createPullRequest(backport);
@@ -280,4 +286,39 @@ describe("github service", () => {
       labels: "label1,label2",
     });
   });
+
+  test("create backport pull request with post comments", async () => {
+    const backport: BackportPullRequest = {
+      title: "Backport Title",
+      body: "Backport Body",
+      owner: "superuser",
+      repo: "backporting-example",
+      base: "old/branch",
+      head: "bp-branch-2",
+      reviewers: [],
+      assignees: [],
+      labels: [],
+      comments: ["this is first comment", "this is second comment"],
+    };
+    
+    const url: string = await gitClient.createPullRequest(backport);
+    expect(url).toStrictEqual("https://my.gitlab.host.com/superuser/backporting-example/-/merge_requests/" + SECOND_NEW_GITLAB_MR_ID);
+
+    // check axios invocation
+    expect(axiosInstanceSpy.post).toBeCalledTimes(1);
+    expect(axiosInstanceSpy.post).toBeCalledWith("/projects/superuser%2Fbackporting-example/merge_requests", expect.objectContaining({
+      source_branch: "bp-branch-2",
+      target_branch: "old/branch",
+      title: "Backport Title",
+      description: "Backport Body",
+      reviewer_ids: [],
+      assignee_ids: [],
+    }));
+    expect(axiosInstanceSpy.get).toBeCalledTimes(0);
+    // FIXME
+    // expect(axiosInstanceSpy.put).toBeCalledTimes(1); // just comments
+    // expect(axiosInstanceSpy.put).toBeCalledWith("/projects/superuser%2Fbackporting-example/merge_requests/" + SECOND_NEW_GITLAB_MR_ID, {
+    //   labels: "label1,label2",
+    // });
+  });
 });

test/service/runner/cli-github-runner.test.ts

@@ -233,6 +233,7 @@ describe("cli runner", () => {
         reviewers: ["gh-user", "that-s-a-user"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -277,6 +278,7 @@ describe("cli runner", () => {
         reviewers: ["gh-user", "that-s-a-user"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -333,6 +335,7 @@ describe("cli runner", () => {
         reviewers: ["gh-user"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -390,6 +393,7 @@ describe("cli runner", () => {
         reviewers: ["user1", "user2"],
         assignees: ["user3", "user4"],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -446,6 +450,7 @@ describe("cli runner", () => {
         reviewers: [],
         assignees: ["user3", "user4"],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -494,11 +499,12 @@ describe("cli runner", () => {
         reviewers: ["gh-user", "that-s-a-user"],
         assignees: [],
         labels: ["cherry-pick :cherries:", "original-label"],
+        comments: [],
       }
     );
   });
 
-  test("set custom lables without inheritance", async () => {
+  test("set custom labels without inheritance", async () => {
     addProcessArgs([
       "-tb",
       "target",
@@ -541,6 +547,7 @@ describe("cli runner", () => {
         reviewers: ["gh-user", "that-s-a-user"],
         assignees: [],
         labels: ["first-label", "second-label"],
+        comments: [],
       }
     );
   });
@@ -584,6 +591,7 @@ describe("cli runner", () => {
         reviewers: [],
         assignees: ["user3", "user4"],
         labels: ["cli github cherry pick :cherries:", "original-label"],
+        comments: [],
       }
     );
   });
@@ -630,6 +638,7 @@ describe("cli runner", () => {
         reviewers: ["gh-user", "that-s-a-user"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -676,6 +685,7 @@ describe("cli runner", () => {
         reviewers: ["gh-user", "that-s-a-user"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -728,6 +738,7 @@ describe("cli runner", () => {
         reviewers: ["gh-user", "that-s-a-user"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -778,6 +789,7 @@ describe("cli runner", () => {
         reviewers: ["gh-user", "that-s-a-user"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });

test/service/runner/cli-gitlab-runner.test.ts

@@ -181,6 +181,7 @@ describe("cli runner", () => {
         reviewers: ["superuser"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -238,6 +239,7 @@ describe("cli runner", () => {
         reviewers: ["superuser"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -296,6 +298,7 @@ describe("cli runner", () => {
         reviewers: ["user1", "user2"],
         assignees: ["user3", "user4"],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -352,6 +355,7 @@ describe("cli runner", () => {
         reviewers: [],
         assignees: ["user3", "user4"],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -401,6 +405,7 @@ describe("cli runner", () => {
         reviewers: ["superuser"],
         assignees: [],
         labels: ["cherry-pick :cherries:", "another-label", "gitlab-original-label"],
+        comments: [],
       }
     );
   });
@@ -449,6 +454,7 @@ describe("cli runner", () => {
         reviewers: ["superuser"],
         assignees: [],
         labels: ["cherry-pick :cherries:", "another-label"],
+        comments: [],
       }
     );
   });
@@ -493,6 +499,7 @@ describe("cli runner", () => {
         reviewers: [],
         assignees: ["user3", "user4"],
         labels: ["cli gitlab cherry pick :cherries:", "gitlab-original-label"],
+        comments: [],
       }
     );
   });
@@ -540,6 +547,7 @@ describe("cli runner", () => {
         reviewers: ["superuser"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });

test/service/runner/gha-github-runner.test.ts

@@ -125,6 +125,7 @@ describe("gha runner", () => {
         reviewers: ["gh-user", "that-s-a-user"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -177,6 +178,7 @@ describe("gha runner", () => {
         reviewers: ["gh-user"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -226,6 +228,7 @@ describe("gha runner", () => {
         reviewers: ["user1", "user2"],
         assignees: ["user3", "user4"],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -276,6 +279,7 @@ describe("gha runner", () => {
         reviewers: [],
         assignees: ["user3", "user4"],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -321,6 +325,7 @@ describe("gha runner", () => {
         reviewers: ["gh-user", "that-s-a-user"],
         assignees: [],
         labels: ["cherry-pick :cherries:", "another-label", "original-label"],
+        comments: [],
       }
     );
   });
@@ -366,6 +371,7 @@ describe("gha runner", () => {
         reviewers: ["gh-user", "that-s-a-user"],
         assignees: [],
         labels: ["cherry-pick :cherries:", "another-label"],
+        comments: [],
       }
     );
   });
@@ -408,6 +414,7 @@ describe("gha runner", () => {
         reviewers: [],
         assignees: ["user3", "user4"],
         labels: ["gha github cherry pick :cherries:", "original-label"],
+        comments: [],
       }
     );
   });
@@ -452,6 +459,7 @@ describe("gha runner", () => {
         reviewers: ["gh-user", "that-s-a-user"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -496,6 +504,7 @@ describe("gha runner", () => {
         reviewers: ["gh-user", "that-s-a-user"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -541,6 +550,7 @@ describe("gha runner", () => {
         reviewers: ["gh-user", "that-s-a-user"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });

test/service/runner/gha-gitlab-runner.test.ts

@@ -136,6 +136,7 @@ describe("gha runner", () => {
         reviewers: ["superuser"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -187,6 +188,7 @@ describe("gha runner", () => {
         reviewers: ["superuser"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -236,6 +238,7 @@ describe("gha runner", () => {
         reviewers: ["user1", "user2"],
         assignees: ["user3", "user4"],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -286,6 +289,7 @@ describe("gha runner", () => {
         reviewers: [],
         assignees: ["user3", "user4"],
         labels: [],
+        comments: [],
       }
     );
   });
@@ -330,6 +334,7 @@ describe("gha runner", () => {
         reviewers: ["superuser"],
         assignees: [],
         labels: ["cherry-pick :cherries:", "another-label", "gitlab-original-label"],
+        comments: [],
       }
     );
   });
@@ -373,6 +378,7 @@ describe("gha runner", () => {
         reviewers: ["superuser"],
         assignees: [],
         labels: ["cherry-pick :cherries:", "another-label"],
+        comments: [],
       }
     );
   });
@@ -416,6 +422,7 @@ describe("gha runner", () => {
         reviewers: [],
         assignees: ["user3", "user4"],
         labels: ["gha gitlab cherry pick :cherries:", "gitlab-original-label"],
+        comments: [],
       }
     );
   });
@@ -461,6 +468,7 @@ describe("gha runner", () => {
         reviewers: ["superuser"],
         assignees: [],
         labels: [],
+        comments: [],
       }
     );
   });