Add /cherry-pick command

The command will cherry-pick the PR changes to the target branch upon merge. Signed-off-by: Chmouel Boudjnah <[email protected]>
openshift-pipelines · Feb 13, 2025 · 2523df5 · 2523df5
1 parent 20181ef
commit 2523df5
Show file tree

Hide file tree

Showing 8 changed files with 346 additions and 175 deletions.
diff --git a/.pylintrc b/.pylintrc
@@ -1,3 +1,3 @@
 [MESSAGES CONTROL]
-disable=redefined-outer-name,line-too-long,missing-function-docstring,missing-module-docstring,too-many-locals,invalid-name
+disable=redefined-outer-name,line-too-long,missing-function-docstring,missing-module-docstring,too-many-locals,invalid-name,protected-access
 
diff --git a/.tekton/prow.yaml b/.tekton/prow.yaml
@@ -5,7 +5,7 @@ metadata:
   name: prow-commands
   annotations:
     pipelinesascode.tekton.dev/pipeline: ".tekton/pipelines/in-repo.yaml"
-    pipelinesascode.tekton.dev/on-comment: "^/(rebase|merge|help|lgtm|(assign|unassign|label|unlabel)[ ].*)$"
+    pipelinesascode.tekton.dev/on-comment: "^/(help|rebase|merge|lgtm|(cherry-pick|assign|unassign|label|unlabel) )"
     pipelinesascode.tekton.dev/max-keep-runs: "2"
 spec:
   params:
@@ -14,7 +14,7 @@ spec:
     - name: revision
       value: "{{revision}}"
     - name: trigger_comment
-      value: |-
+      value: |
         {{ trigger_comment }}
     - name: repo_owner
       value: "{{ repo_owner }}"

diff --git a/README.md b/README.md
@@ -8,16 +8,22 @@ Pipelines As Code Prow let you trigger Tekton Pipelines based on GitHub comments
 
 The following commands are supported:
 
-| Command                 | Description                                                      |
-|-------------------------|------------------------------------------------------------------|
-| `/assign user1 user2`   | Assigns users for review to the PR                               |
-| `/unassign user1 user2` | Removes assigned users                                           |
-| `/label bug feature`    | Adds labels to the PR                                            |
-| `/unlabel bug feature`  | Removes labels from the PR                                       |
-| `/lgtm`                 | Approves the PR if at least 1 org members have commented `/lgtm` |
-| `/merge`                | Merges the PR if it has enough `/lgtm` approvals                 |
-| `/rebase`               | Rebases the PR branch on the base branch                         |
-| `/help`                 | Shows this help message                                          |
+| Command                      | Description                                                      |
+|------------------------------|------------------------------------------------------------------|
+| `/assign user1 user2`        | Assigns users for review to the PR                               |
+| `/unassign user1 user2`      | Removes assigned users                                           |
+| `/label bug feature`         | Adds labels to the PR                                            |
+| `/unlabel bug feature`       | Removes labels from the PR                                       |
+| `/cherry-pick target-branch` | Cherry-picks the PR changes to the target branch on Merges       |
+| `/lgtm`                      | Approves the PR if at least 1 org members have commented `/lgtm` |
+| `/merge`                     | Merges the PR if it has enough `/lgtm` approvals                 |
+| `/rebase`                    | Rebases the PR branch on the base branch                         |
+| `/help`                      | Shows this help message                                          |
+
+> [!IMPORTANT]
+>
+> * Please note that multiple comment on the same line are not supported, you need to issue one command per comment.
+> * The command needs to be located at the beginning of the comment, if there is any other text before the command it will be ignored.
 
 ## Usage
 
@@ -32,12 +38,12 @@ metadata:
   name: prow-commands
   annotations:
     pipelinesascode.tekton.dev/pipeline: "https://raw.githubusercontent.com/openshift-pipelines/pipelines-as-code-prow/refs/heads/main/pipeline-prow.yaml"
-    pipelinesascode.tekton.dev/on-comment: "^/(help|rebase|merge|lgtm|(assign|unassign|label|unlabel)[ ].*)$"
+    pipelinesascode.tekton.dev/on-comment: "^/(help|rebase|merge|lgtm|(cherry-pick|assign|unassign|label|unlabel)[ ].*)$"
     pipelinesascode.tekton.dev/max-keep-runs: "2"
 spec:
   params:
     - name: trigger_comment
-      value: |- # make sure to use |- or it will fail with a simple |
+      value: |
         {{ trigger_comment }}
     - name: repo_owner
       value: "{{ repo_owner }}"

diff --git a/pipeline-prow.yaml b/pipeline-prow.yaml
@@ -5,7 +5,7 @@ metadata:
   name: prow-commands
   annotations:
     pipelinesascode.tekton.dev/on-comment: |
-      ^/(help|rebase|merge|lgtm|(assign|unassign|label|unlabel)[ ].*)$
+      ^/(help|rebase|merge|lgtm|(cherry-pick|assign|unassign|label|unlabel)[ ].*)$
     pipelinesascode.tekton.dev/max-keep-runs: "5"
 spec:
   params:

diff --git a/pipelines_as_code_prow/base.yaml b/pipelines_as_code_prow/base.yaml
diff --git a/pipelines_as_code_prow/messages.py b/pipelines_as_code_prow/messages.py
@@ -142,3 +142,32 @@
 
 Please resolve any issues and try again.
 """
+
+# Add new error message template for cherry-pick
+CHERRY_PICK_ERROR = """
+### ❌ Cherry Pick Failed
+
+Failed to cherry-pick changes from PR #{source_pr} to branch `{target_branch}`:
+* Status Code: `{status_code}`
+* Error: `{error_text}`
+
+**Possible causes:**
+* Merge conflicts
+* Branch protection rules
+* Invalid branch name
+* Missing permissions
+
+Please resolve any issues and try again.
+"""
+
+CHERRY_PICK_SUCCESS = """
+### ✅ Cherry Pick Successful
+
+Successfully cherry-picked changes from PR #{source_pr} to branch `{target_branch}`.
+
+**Details:**
+* Source PR: #{source_pr}
+* Target Branch: `{target_branch}`
+* Cherry-picked by: @{user}
+* New commit SHA: `{commit_sha}`
+"""