Merge pull request #416 from AlexVermette-Eaton/feature/branch_name

Add configurable `branch_name` input

.gitignore

@@ -1,5 +1,6 @@
 lib
 .vscode/
+.vs/
 
 # Modified from https://www.toptal.com/developers/gitignore/api/node,intellij+all,visualstudiocode,macos,windows
 #dist # removed because this action requires the dist to be available in the repo

README.md

@@ -105,6 +105,16 @@ jobs:
 
 The action can be configured with the following optional [inputs](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswith):
 
+### `branch_name`
+
+Default: `backport-${pull_number}-to-${target_branch}`
+
+Template used as the name for branches created by this action. 
+
+Placeholders can be used to define variable values.
+These are indicated by a dollar sign and curly braces (`${placeholder}`).
+Please refer to this action's README for all available [placeholders](#placeholders).
+
 ### `copy_assignees`
 
 Default: `false` (disabled)

action.yml

@@ -3,6 +3,13 @@ description: >
   Fast and flexible action to cherry-pick commits from labeled pull requests
 author: korthout
 inputs:
+  branch_name:
+    description: >
+      Template used as the name for branches created by this action. 
+      Placeholders can be used to define variable values.
+      These are indicated by a dollar sign and curly braces (`${placeholder}`).
+      Please refer to this action's README for all available placeholders.
+    default: backport-${pull_number}-to-${target_branch}
   copy_assignees:
     description: >
       Controls whether to copy the assignees from the original pull request to the backport pull request.

dist/index.js

@@ -187,7 +187,7 @@ class Backport {
                         }
                     }
                     try {
-                        const branchname = `backport-${pull_number}-to-${target}`;
+                        const branchname = utils.replacePlaceholders(this.config.pull.branch_name, mainpr, target);
                         console.log(`Start backport to ${branchname}`);
                         try {
                             yield this.git.checkout(branchname, `origin/${target}`, this.config.pwd);
@@ -932,6 +932,7 @@ function run() {
         const pattern = core.getInput("label_pattern");
         const description = core.getInput("pull_description");
         const title = core.getInput("pull_title");
+        const branch_name = core.getInput("branch_name");
         const copy_labels_pattern = core.getInput("copy_labels_pattern");
         const target_branches = core.getInput("target_branches");
         const merge_commits = core.getInput("merge_commits");
@@ -957,7 +958,7 @@ function run() {
         const config = {
             pwd,
             labels: { pattern: pattern === "" ? undefined : new RegExp(pattern) },
-            pull: { description, title },
+            pull: { description, title, branch_name },
             copy_labels_pattern: copy_labels_pattern === "" ? undefined : new RegExp(copy_labels_pattern),
             target_branches: target_branches === "" ? undefined : target_branches,
             commits: { merge_commits },

src/backport.ts

@@ -23,6 +23,7 @@ export type Config = {
   pull: {
     description: string;
     title: string;
+    branch_name: string;
   };
   copy_labels_pattern?: RegExp;
   target_branches?: string;
@@ -234,7 +235,11 @@ export class Backport {
         }
 
         try {
-          const branchname = `backport-${pull_number}-to-${target}`;
+          const branchname = utils.replacePlaceholders(
+            this.config.pull.branch_name,
+            mainpr,
+            target,
+          );
 
           console.log(`Start backport to ${branchname}`);
           try {

src/main.ts

@@ -16,6 +16,7 @@ async function run(): Promise<void> {
   const pattern = core.getInput("label_pattern");
   const description = core.getInput("pull_description");
   const title = core.getInput("pull_title");
+  const branch_name = core.getInput("branch_name");
   const copy_labels_pattern = core.getInput("copy_labels_pattern");
   const target_branches = core.getInput("target_branches");
   const merge_commits = core.getInput("merge_commits");
@@ -44,7 +45,7 @@ async function run(): Promise<void> {
   const config: Config = {
     pwd,
     labels: { pattern: pattern === "" ? undefined : new RegExp(pattern) },
-    pull: { description, title },
+    pull: { description, title, branch_name },
     copy_labels_pattern:
       copy_labels_pattern === "" ? undefined : new RegExp(copy_labels_pattern),
     target_branches: target_branches === "" ? undefined : target_branches,