Add git cherry-pick --keep-redundant-commits

Signed-off-by: Edward Yang <[email protected]>
ghstack-source-id: 95ba1cc
ghstack-comment-id: 3356766430
Pull-Request: #301

Author: ezyang

src/ghstack/cherry_pick.py

@@ -14,6 +14,7 @@ def main(
     sh: ghstack.shell.Shell,
     remote_name: str,
     stack: bool = False,
+    keep_redundant_commits: bool = False,
 ) -> None:
 
     params = ghstack.github_utils.parse_pull_request(
@@ -56,10 +57,18 @@ def main(
 
         logging.info(f"Cherry-picking {len(commit_list)} commits from stack")
         for commit in commit_list:
-            sh.git("cherry-pick", commit)
+            args = ["cherry-pick"]
+            if keep_redundant_commits:
+                args.append("--keep-redundant-commits")
+            args.append(commit)
+            sh.git(*args)
             logging.info(f"Cherry-picked {commit}")
     else:
         # Cherry-pick just the single commit
         remote_orig_ref = remote_name + "/" + orig_ref
-        sh.git("cherry-pick", remote_orig_ref)
+        args = ["cherry-pick"]
+        if keep_redundant_commits:
+            args.append("--keep-redundant-commits")
+        args.append(remote_orig_ref)
+        sh.git(*args)
         logging.info(f"Cherry-picked {orig_ref}")

src/ghstack/cli.py

@@ -134,8 +134,13 @@ def checkout(pull_request: str) -> None:
     is_flag=True,
     help="Cherry-pick all commits from the commit to the merge-base with main branch",
 )
+@click.option(
+    "--keep-redundant-commits",
+    is_flag=True,
+    help="Keep redundant commits when cherry-picking (passed to git cherry-pick)",
+)
 @click.argument("pull_request", metavar="PR")
-def cherry_pick(stack: bool, pull_request: str) -> None:
+def cherry_pick(stack: bool, keep_redundant_commits: bool, pull_request: str) -> None:
     """
     Cherry-pick a PR
     """
@@ -146,6 +151,7 @@ def cherry_pick(stack: bool, pull_request: str) -> None:
             sh=shell,
             remote_name=config.remote_name,
             stack=stack,
+            keep_redundant_commits=keep_redundant_commits,
         )
 
 

src/ghstack/test_prelude.py

@@ -240,14 +240,15 @@ def gh_unlink() -> None:
     )
 
 
-def gh_cherry_pick(pull_request: str, stack: bool = False) -> None:
+def gh_cherry_pick(pull_request: str, stack: bool = False, keep_redundant_commits: bool = False) -> None:
     self = CTX
     return ghstack.cherry_pick.main(
         pull_request=pull_request,
         github=self.github,
         sh=self.sh,
         remote_name="origin",
         stack=stack,
+        keep_redundant_commits=keep_redundant_commits,
     )