Allow to disable opening the web browser/creating PR (#36)

Author: Jackenmen

cherry_picker/cherry_picker.py

@@ -98,6 +98,7 @@ def __init__(
         prefix_commit=True,
         config=DEFAULT_CONFIG,
         chosen_config_path=None,
+        auto_pr=True,
     ):
 
         self.chosen_config_path = chosen_config_path
@@ -125,6 +126,7 @@ def __init__(
         self.branches = branches
         self.dry_run = dry_run
         self.push = push
+        self.auto_pr = auto_pr
         self.prefix_commit = prefix_commit
 
     def set_paused_state(self):
@@ -297,6 +299,8 @@ def push_to_remote(self, base_branch, head_branch, commit_message=""):
             click.echo(cpe.output)
             set_state(WORKFLOW_STATES.PUSHING_TO_REMOTE_FAILED)
         else:
+            if not self.auto_pr:
+                return
             gh_auth = os.getenv("GH_AUTH")
             if gh_auth:
                 set_state(WORKFLOW_STATES.PR_CREATING)
@@ -577,6 +581,17 @@ class state:
     default=True,
     help="Changes won't be pushed to remote",
 )
+@click.option(
+    "--auto-pr/--no-auto-pr",
+    "auto_pr",
+    is_flag=True,
+    default=True,
+    help=(
+        "If auto PR is enabled, cherry-picker will automatically open a PR"
+        " through API if GH_AUTH env var is set, or automatically open the PR"
+        " creation page in the web browser otherwise."
+    ),
+)
 @click.option(
     "--config-path",
     "config_path",
@@ -592,7 +607,7 @@ class state:
 @click.argument("branches", nargs=-1)
 @click.pass_context
 def cherry_pick_cli(
-    ctx, dry_run, pr_remote, abort, status, push, config_path, commit_sha1, branches
+    ctx, dry_run, pr_remote, abort, status, push, auto_pr, config_path, commit_sha1, branches
 ):
     """cherry-pick COMMIT_SHA1 into target BRANCHES."""
 
@@ -607,6 +622,7 @@ def cherry_pick_cli(
             branches,
             dry_run=dry_run,
             push=push,
+            auto_pr=auto_pr,
             config=config,
             chosen_config_path=chosen_config_path,
         )

cherry_picker/test.py

@@ -679,6 +679,18 @@ def test_push_to_remote_botflow(tmp_git_repo_dir, monkeypatch):
     assert get_state() == WORKFLOW_STATES.PR_CREATING
 
 
+def test_push_to_remote_no_auto_pr(tmp_git_repo_dir, monkeypatch):
+    monkeypatch.setenv("GH_AUTH", "True")
+    with mock.patch("cherry_picker.cherry_picker.validate_sha", return_value=True):
+        cherry_picker = CherryPicker("origin", "xxx", [], auto_pr=False)
+
+    with mock.patch.object(cherry_picker, "run_cmd"), mock.patch.object(
+        cherry_picker, "create_gh_pr"
+    ):
+        cherry_picker.push_to_remote("main", "backport-branch-test")
+    assert get_state() == WORKFLOW_STATES.PUSHED_TO_REMOTE
+
+
 def test_backport_no_branch(tmp_git_repo_dir, monkeypatch):
     with mock.patch("cherry_picker.cherry_picker.validate_sha", return_value=True):
         cherry_picker = CherryPicker("origin", "xxx", [])