ghstack 0.10.0__tar.gz → 0.12.0__tar.gz

{ghstack-0.10.0 → ghstack-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ghstack
-Version: 0.10.0
+Version: 0.12.0
 Summary: Stack diff support for GitHub
 Author: Edward Z. Yang
 Author-email: Edward Z. Yang <ezyang@mit.edu>
@@ -14,7 +14,7 @@ Requires-Dist: requests>=2,<3
 Requires-Dist: typing-extensions>=3
 Requires-Dist: click>=8,<9
 Requires-Dist: flake8>=7.0.0,<8.0.0
-Requires-Python: >=3.8.1, <4.0.0
+Requires-Python: >=3.9.1, <4.0.0
 Project-URL: repository, https://github.com/ezyang/ghstack
 Description-Content-Type: text/markdown
 
@@ -28,7 +28,7 @@ uv tool install ghstack
 
 ghstack is tested with 
 [several different Python versions](https://github.com/ezyang/ghstack/blob/master/.github/workflows/test.yml#L13). 
-It requires at least Python 3.8.1.
+It requires at least Python 3.9.1.
 
 ## How to setup
 
@@ -69,13 +69,13 @@ resolve conflicts in *each* PR, not just for the entire stack.)
 **How do I start a new feature?**  Just checkout master on a new
 branch, and start working on a fresh branch.
 
-**WARNING.**  You will NOT be able to merge these commits using the
-normal GitHub UI, as their branch bases won't be master.  Use
-`ghstack land $PR_URL` (or alternatively `ghstack land #PR_NUM`) to land
+**How do I merge my changes?**  Warning: You will NOT be able to merge these 
+commits using the normal GitHub UI, as their branch bases won't be master.  
+Use `ghstack land $PR_URL` (or alternatively `ghstack land #PR_NUM`) to land
 a ghstack'ed pull request.
 
 You can also setup a GitHub action to allow a bot land.
-[ghstack_land_example](https://github.com/Chillee/ghstack_land_example/blob/main/.github/workflows/issue_comment.yml)
+[ghstack_land_example](https://github.com/Chillee/ghstack_land_example/blob/main/.github/workflows/ghstack_land.yml)
 is an end-to-end example of how to do this.
 
 ## Structure of submitted pull requests

{ghstack-0.10.0 → ghstack-0.12.0}/README.md

@@ -8,7 +8,7 @@ uv tool install ghstack
 
 ghstack is tested with 
 [several different Python versions](https://github.com/ezyang/ghstack/blob/master/.github/workflows/test.yml#L13). 
-It requires at least Python 3.8.1.
+It requires at least Python 3.9.1.
 
 ## How to setup
 
@@ -49,13 +49,13 @@ resolve conflicts in *each* PR, not just for the entire stack.)
 **How do I start a new feature?**  Just checkout master on a new
 branch, and start working on a fresh branch.
 
-**WARNING.**  You will NOT be able to merge these commits using the
-normal GitHub UI, as their branch bases won't be master.  Use
-`ghstack land $PR_URL` (or alternatively `ghstack land #PR_NUM`) to land
+**How do I merge my changes?**  Warning: You will NOT be able to merge these 
+commits using the normal GitHub UI, as their branch bases won't be master.  
+Use `ghstack land $PR_URL` (or alternatively `ghstack land #PR_NUM`) to land
 a ghstack'ed pull request.
 
 You can also setup a GitHub action to allow a bot land.
-[ghstack_land_example](https://github.com/Chillee/ghstack_land_example/blob/main/.github/workflows/issue_comment.yml)
+[ghstack_land_example](https://github.com/Chillee/ghstack_land_example/blob/main/.github/workflows/ghstack_land.yml)
 is an end-to-end example of how to do this.
 
 ## Structure of submitted pull requests

{ghstack-0.10.0 → ghstack-0.12.0}/pyproject.toml

@@ -3,7 +3,7 @@ authors = [
     {name = "Edward Z. Yang", email = "ezyang@mit.edu"},
 ]
 license = {text = "MIT"}
-requires-python = "<4.0.0,>=3.8.1"
+requires-python = "<4.0.0,>=3.9.1"
 dependencies = [
     "aiohttp<4,>=3",
     "importlib-metadata>=1.4; python_version < \"3.8\"",
@@ -13,7 +13,7 @@ dependencies = [
     "flake8<8.0.0,>=7.0.0",
 ]
 name = "ghstack"
-version = "0.10.0"
+version = "0.12.0"
 description = "Stack diff support for GitHub"
 readme = "README.md"
 classifiers = [

ghstack-0.12.0/src/ghstack/cherry_pick.py

@@ -0,0 +1,65 @@
+#!/usr/bin/env python3
+
+import logging
+import re
+
+import ghstack.github
+import ghstack.github_utils
+import ghstack.shell
+
+
+def main(
+    pull_request: str,
+    github: ghstack.github.GitHubEndpoint,
+    sh: ghstack.shell.Shell,
+    remote_name: str,
+    stack: bool = False,
+) -> None:
+
+    params = ghstack.github_utils.parse_pull_request(
+        pull_request, sh=sh, remote_name=remote_name
+    )
+    head_ref = github.get_head_ref(**params)
+    orig_ref = re.sub(r"/head$", "/orig", head_ref)
+    if orig_ref == head_ref:
+        logging.warning(
+            "The ref {} doesn't look like a ghstack reference".format(head_ref)
+        )
+
+    sh.git("fetch", "--prune", remote_name)
+
+    if stack:
+        # Cherry-pick the entire stack from merge-base to the commit
+        remote_orig_ref = remote_name + "/" + orig_ref
+
+        # Find the merge-base with the main branch
+        repo_info = ghstack.github_utils.get_github_repo_info(
+            github=github,
+            sh=sh,
+            github_url=params["github_url"],
+            remote_name=remote_name,
+        )
+        main_branch = f"{remote_name}/{repo_info['default_branch']}"
+
+        # Get merge-base between the commit and main branch
+        merge_base = sh.git("merge-base", main_branch, remote_orig_ref).strip()
+
+        # Get all commits from merge-base to the target commit
+        commit_list = (
+            sh.git("rev-list", "--reverse", f"{merge_base}..{remote_orig_ref}")
+            .strip()
+            .split("\n")
+        )
+
+        if not commit_list or commit_list == [""]:
+            raise RuntimeError("No commits found to cherry-pick in the specified range")
+
+        logging.info(f"Cherry-picking {len(commit_list)} commits from stack")
+        for commit in commit_list:
+            sh.git("cherry-pick", commit)
+            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)
+        logging.info(f"Cherry-picked {orig_ref}")

{ghstack-0.10.0 → ghstack-0.12.0}/src/ghstack/cli.py

@@ -7,6 +7,7 @@ import click
 import ghstack
 import ghstack.action
 import ghstack.checkout
+import ghstack.cherry_pick
 import ghstack.circleci_real
 import ghstack.config
 import ghstack.github_real
@@ -126,6 +127,28 @@ def checkout(pull_request: str) -> None:
         )
 
 
+@main.command("cherry-pick")
+@click.option(
+    "--stack",
+    "-s",
+    is_flag=True,
+    help="Cherry-pick all commits from the commit to the merge-base with main branch",
+)
+@click.argument("pull_request", metavar="PR")
+def cherry_pick(stack: bool, pull_request: str) -> None:
+    """
+    Cherry-pick a PR
+    """
+    with cli_context(request_github_token=False) as (shell, config, github):
+        ghstack.cherry_pick.main(
+            pull_request=pull_request,
+            github=github,
+            sh=shell,
+            remote_name=config.remote_name,
+            stack=stack,
+        )
+
+
 @main.command("land")
 @click.option("--force", is_flag=True, help="force land even if the PR is closed")
 @click.argument("pull_request", metavar="PR")

{ghstack-0.10.0 → ghstack-0.12.0}/src/ghstack/diff.py

@@ -14,7 +14,7 @@ RE_GH_METADATA = re.compile(
 
 
 RAW_PULL_REQUEST_RESOLVED = (
-    r"(Pull Request resolved|Pull-Request-resolved): "
+    r"(Pull Request resolved|Pull-Request-resolved|Pull-Request): "
     r"https://{github_url}/(?P<owner>[^/]+)/(?P<repo>[^/]+)/pull/(?P<number>[0-9]+)"
 )
 
@@ -93,7 +93,7 @@ class Diff:
     # be the same.
     source_id: str
 
-    # The contents of 'Pull-Request-resolved'.  This is None for
+    # The contents of 'Pull-Request'.  This is None for
     # diffs that haven't been submitted by ghstack.  For BC reasons,
     # this also accepts gh-metadata.
     pull_request_resolved: Optional[PullRequestResolved]

{ghstack-0.10.0 → ghstack-0.12.0}/src/ghstack/github_real.py

@@ -3,12 +3,16 @@
 import json
 import logging
 import re
+import time
 from typing import Any, Dict, Optional, Sequence, Tuple, Union
 
 import requests
 
 import ghstack.github
 
+MAX_RETRIES = 5
+INITIAL_BACKOFF_SECONDS = 60
+
 
 class RealGitHubEndpoint(ghstack.github.GitHubEndpoint):
     """
@@ -155,32 +159,63 @@ class RealGitHubEndpoint(ghstack.github.GitHubEndpoint):
         }
 
         url = self.rest_endpoint.format(github_url=self.github_url) + "/" + path
-        logging.debug("# {} {}".format(method, url))
-        logging.debug("Request body:\n{}".format(json.dumps(kwargs, indent=1)))
 
-        resp: requests.Response = getattr(requests, method)(
-            url,
-            json=kwargs,
-            headers=headers,
-            proxies=self._proxies(),
-            verify=self.verify,
-            cert=self.cert,
-        )
+        backoff_seconds = INITIAL_BACKOFF_SECONDS
+        for attempt in range(0, MAX_RETRIES):
+            logging.debug("# {} {}".format(method, url))
+            logging.debug("Request body:\n{}".format(json.dumps(kwargs, indent=1)))
 
-        logging.debug("Response status: {}".format(resp.status_code))
+            resp: requests.Response = getattr(requests, method)(
+                url,
+                json=kwargs,
+                headers=headers,
+                proxies=self._proxies(),
+                verify=self.verify,
+                cert=self.cert,
+            )
 
-        try:
-            r = resp.json()
-        except ValueError:
-            logging.debug("Response body:\n{}".format(r.text))
-            raise
-        else:
-            pretty_json = json.dumps(r, indent=1)
-            logging.debug("Response JSON:\n{}".format(pretty_json))
+            logging.debug("Response status: {}".format(resp.status_code))
 
-        if resp.status_code == 404:
-            raise ghstack.github.NotFoundError(
-                """\
+            try:
+                r = resp.json()
+            except ValueError:
+                logging.debug("Response body:\n{}".format(r.text))
+                raise
+            else:
+                pretty_json = json.dumps(r, indent=1)
+                logging.debug("Response JSON:\n{}".format(pretty_json))
+
+            # Per Github rate limiting: https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28#exceeding-the-rate-limit
+            if resp.status_code in (403, 429):
+                remaining_count = resp.headers.get("x-ratelimit-remaining")
+                reset_time = resp.headers.get("x-ratelimit-reset")
+
+                if remaining_count == "0" and reset_time:
+                    sleep_time = int(reset_time) - int(time.time())
+                    logging.warning(
+                        f"Rate limit exceeded. Sleeping until reset in {sleep_time} seconds."
+                    )
+                    time.sleep(sleep_time)
+                    continue
+                else:
+                    retry_after_seconds = resp.headers.get("retry-after")
+                    if retry_after_seconds:
+                        sleep_time = int(retry_after_seconds)
+                        logging.warning(
+                            f"Secondary rate limit hit. Sleeping for {sleep_time} seconds."
+                        )
+                    else:
+                        sleep_time = backoff_seconds
+                        logging.warning(
+                            f"Secondary rate limit hit. Sleeping for {sleep_time} seconds (exponential backoff)."
+                        )
+                        backoff_seconds *= 2
+                    time.sleep(sleep_time)
+                    continue
+
+            if resp.status_code == 404:
+                raise ghstack.github.NotFoundError(
+                    """\
 GitHub raised a 404 error on the request for
 {url}.
 Usually, this doesn't actually mean the page doesn't exist; instead, it
@@ -189,14 +224,20 @@ permissions.  Please create a new OAuth token at
 https://{github_url}/settings/tokens and DOUBLE CHECK that you checked
 "public_repo" for permissions, and update ~/.ghstackrc with your new
 value.
+
+Another possible reason for this error is if the repository has moved
+to a new location or been renamed. Check that the repository URL is
+still correct.
 """.format(
-                    url=url, github_url=self.github_url
+                        url=url, github_url=self.github_url
+                    )
                 )
-            )
 
-        try:
-            resp.raise_for_status()
-        except requests.HTTPError:
-            raise RuntimeError(pretty_json)
+            try:
+                resp.raise_for_status()
+            except requests.HTTPError:
+                raise RuntimeError(pretty_json)
 
-        return r
+            return r
+
+        raise RuntimeError("Exceeded maximum retries due to GitHub rate limiting")

{ghstack-0.10.0 → ghstack-0.12.0}/src/ghstack/github_utils.py

@@ -77,20 +77,43 @@ def get_github_repo_info(
         name_with_owner = {"owner": repo_owner, "name": repo_name}
 
     # TODO: Cache this guy
-    repo = github.graphql(
-        """
-        query ($owner: String!, $name: String!) {
-            repository(name: $name, owner: $owner) {
-                id
-                isFork
-                defaultBranchRef {
-                    name
+    try:
+        repo = github.graphql(
+            """
+            query ($owner: String!, $name: String!) {
+                repository(name: $name, owner: $owner) {
+                    id
+                    isFork
+                    defaultBranchRef {
+                        name
+                    }
                 }
-            }
-        }""",
-        owner=name_with_owner["owner"],
-        name=name_with_owner["name"],
-    )["data"]["repository"]
+            }""",
+            owner=name_with_owner["owner"],
+            name=name_with_owner["name"],
+        )["data"]["repository"]
+    except RuntimeError as e:
+        # Check if this is a repository access error (NOT_FOUND)
+        error_msg = str(e)
+        if (
+            "Could not resolve to a Repository" in error_msg
+            and "NOT_FOUND" in error_msg
+        ):
+            raise RuntimeError(
+                f"Original error: {error_msg}\n\n"
+                f"Could not access repository '{name_with_owner['owner']}/{name_with_owner['name']}'. "
+                f"This usually means:\n"
+                f"1. The repository is private and your OAuth token doesn't have access\n"
+                f"2. The repository is in a different organization that hasn't granted access\n"
+                f"3. The repository doesn't exist or has been moved\n\n"
+                f"If this is a private repository or in a separate organization, you can grant access by:\n"
+                f"1. Delete the 'github_oauth' entry from your .ghstackrc file\n"
+                f"2. Run ghstack again to redo the OAuth flow\n"
+                f"3. Make sure to grant access to the appropriate organizations when prompted"
+            )
+        else:
+            # Re-raise the original error if it's not the repository access issue
+            raise
 
     return {
         "name_with_owner": name_with_owner,

{ghstack-0.10.0 → ghstack-0.12.0}/src/ghstack/land.py

@@ -152,11 +152,18 @@ to complain to the ghstack authors."""
                 sh.git("cherry-pick", "--abort")
                 raise
 
+        # All good! Push!
+        maybe_force_arg = []
+        if needs_force:
+            maybe_force_arg = ["--force-with-lease"]
+        sh.git(
+            "push", *maybe_force_arg, remote_name, f"HEAD:refs/heads/{default_branch}"
+        )
+
         # Advance base to head to "close" the PR for all PRs.
-        # This has to happen before the push because the push
-        # will trigger a closure, but we want a *merge*.  This should
-        # happen after the cherry-pick, because the cherry-picks can
-        # fail
+        # This happens after the cherry-pick and push, because the cherry-picks
+        # can fail (merge conflict) and the push can also fail (race condition)
+
         # TODO: It might be helpful to advance orig to reflect the true
         # state of upstream at the time we are doing the land, and then
         # directly *merge* head into base, so that the PR accurately
@@ -173,21 +180,19 @@ to complain to the ghstack authors."""
             )
             github.notify_merged(pr_resolved)
 
-        # All good! Push!
-        maybe_force_arg = []
-        if needs_force:
-            maybe_force_arg = ["--force-with-lease"]
-        sh.git(
-            "push", *maybe_force_arg, remote_name, f"HEAD:refs/heads/{default_branch}"
-        )
-
         # Delete the branches
         for orig_ref, _ in stack_orig_refs:
             # TODO: regex here so janky
             base_ref = re.sub(r"/orig$", "/base", orig_ref)
             head_ref = re.sub(r"/orig$", "/head", orig_ref)
             try:
-                sh.git("push", remote_name, "--delete", orig_ref, base_ref, head_ref)
+                sh.git("push", remote_name, "--delete", orig_ref, base_ref)
+            except RuntimeError:
+                # Whatever, keep going
+                logging.warning("Failed to delete branch, continuing", exc_info=True)
+            # Try deleting head_ref separately since often after it's merged it doesn't exist anymore
+            try:
+                sh.git("push", remote_name, "--delete", head_ref)
             except RuntimeError:
                 # Whatever, keep going
                 logging.warning("Failed to delete branch, continuing", exc_info=True)

{ghstack-0.10.0 → ghstack-0.12.0}/src/ghstack/submit.py

@@ -167,9 +167,7 @@ def strip_mentions(body: str) -> str:
     return RE_MENTION.sub(r"\1", body)
 
 
-STACK_HEADER = (
-    "Stack from [ghstack](https://github.com/ezyang/ghstack) (oldest at bottom)"
-)
+STACK_HEADER = f"Stack from [ghstack](https://github.com/ezyang/ghstack/tree/{ghstack.__version__}) (oldest at bottom)"
 
 
 def starts_with_bullet(body: str) -> bool:
@@ -468,12 +466,6 @@ class Submitter:
             raise RuntimeError(
                 "There appears to be no commits to process, based on the revs you passed me."
             )
-        elif commit_count > 8 and not self.force:
-            raise RuntimeError(
-                "Cowardly refusing to handle a stack with more than eight PRs.  "
-                "You are likely to get rate limited by GitHub if you try to create or "
-                "manipulate this many PRs.  You can bypass this throttle using --force"
-            )
 
         # This is not really accurate if you're doing a fancy pattern;
         # if this is a problem file us a bug.
@@ -816,7 +808,7 @@ as it supports bidirectional syncing.  However, there is no way to
 convert a pre-existing PR in the old style to the new format which
 supports bidirectional syncing.  If you would like to blow away the old
 PR and start anew, edit the Summary in the Phabricator diff to delete
-the line 'Pull-Request-resolved' and then run ghexport again.
+the line 'Pull-Request' and then run ghexport again.
 """
             )
 
@@ -833,7 +825,7 @@ the Phabricator diff page?  If so, please continue to use that button
 to export your diff.
 
 If you think this is in error, edit the Summary in the Phabricator diff
-to delete the line 'Pull-Request-resolved' and then run ghexport again.
+to delete the line 'Pull-Request' and then run ghexport again.
 """
                 )
             else:
@@ -970,9 +962,7 @@ to disassociate the commit with the pull request, and then try again.
             if self.direct:
                 trailers_to_add.append(f"ghstack-comment-id: {elab_diff.comment_id}")
 
-            trailers_to_add.append(
-                f"Pull-Request-resolved: {pull_request_resolved.url()}"
-            )
+            trailers_to_add.append(f"Pull-Request: {pull_request_resolved.url()}")
 
             commit_msg = ghstack.trailers.interpret_trailers(
                 strip_mentions(diff.summary.rstrip()), trailers_to_add
@@ -1779,7 +1769,7 @@ is closed (likely due to being merged).  Please rebase to upstream and try again
         commit_body = RE_GHSTACK_SOURCE_ID.sub("", commit_body)
         # Comment ID is not necessary; source of truth is orig commit
         commit_body = RE_GHSTACK_COMMENT_ID.sub("", commit_body)
-        # Don't store Pull request resolved in the PR body; it's
+        # Don't store Pull request in the PR body; it's
         # unnecessary
         commit_body = ghstack.diff.re_pull_request_resolved_w_sp(self.github_url).sub(
             "", commit_body

{ghstack-0.10.0 → ghstack-0.12.0}/src/ghstack/test_prelude.py

@@ -12,6 +12,8 @@ from typing import Any, Callable, Iterator, List, Optional, Sequence, Tuple, Uni
 
 from expecttest import assert_expected_inline
 
+import ghstack.cherry_pick
+
 import ghstack.github
 import ghstack.github_fake
 import ghstack.github_utils
@@ -29,6 +31,7 @@ __all__ = [
     "gh_submit",
     "gh_land",
     "gh_unlink",
+    "gh_cherry_pick",
     "GitCommitHash",
     "checkout",
     "amend",
@@ -237,6 +240,17 @@ def gh_unlink() -> None:
     )
 
 
+def gh_cherry_pick(pull_request: str, stack: 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,
+    )
+
+
 def write_file_and_add(filename: str, contents: str) -> None:
     self = CTX
     with self.sh.open(filename, "w") as f: