ghstack 0.9.4__tar.gz → 0.9.5__tar.gz

ghstack-0.9.4/README.md → ghstack-0.9.5/PKG-INFO

@@ -1,3 +1,23 @@
+Metadata-Version: 2.3
+Name: ghstack
+Version: 0.9.5
+Summary: Stack diff support for GitHub
+Author: Edward Z. Yang
+Author-email: Edward Z. Yang <ezyang@mit.edu>
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Dist: aiohttp>=3,<4
+Requires-Dist: importlib-metadata>=1.4 ; python_full_version < '3.8'
+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
+Project-URL: repository, https://github.com/ezyang/ghstack
+Description-Content-Type: text/markdown
+
 # ghstack
 
 Conveniently submit stacks of diffs to GitHub as separate pull requests.
@@ -51,7 +71,11 @@ 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` to land a ghstack'ed pull request.
+`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.
+https://github.com/Chillee/ghstack_land_example/blob/main/.github/workflows/issue_comment.yml is an end-to-end example of how to do this.
 
 ## Structure of submitted pull requests
 
@@ -73,51 +97,6 @@ pull request and pushes commits onto three branches:
   want to work on the commits from another machine, this is the best way
   to get it.
 
-## Developer notes
-
-This project uses [Poetry](https://python-poetry.org/docs/#installation), so
-after you've installed Poetry itself, run this command in your clone of this
-repo to install all the dependencies you need for working on `ghstack`:
-```
-poetry install
-```
-Note that this installs the dependencies (and `ghstack` itself) in an isolated
-Python virtual environment rather than globally. If your cwd is in your clone of
-this repo then you can run your locally-built `ghstack` using `poetry run
-ghstack $ARGS`, but if you want to run it from somewhere else, you probably want
-[`poetry shell`](https://python-poetry.org/docs/cli/#shell) instead:
-```
-poetry shell
-cd $SOMEWHERE
-ghstack $ARGS
-```
-
-### Testing
-
-We have tests, using a mock GitHub GraphQL server!  How cool is that?
-```
-poetry run python test_ghstack.py
-```
-That runs most of the tests; you can run all tests (including lints) like this:
-```
-poetry run python run_tests.py
-```
-
-### Publishing
-
-You can also [use Poetry to
-publish](https://python-poetry.org/docs/cli/#publish) to a package repository.
-For instance, if you've configured your [Poetry
-repositories](https://python-poetry.org/docs/repositories/) like this:
-```
-poetry config repositories.testpypi https://test.pypi.org/legacy/
-```
-Then you can publish to TestPyPI like this:
-```
-poetry publish --build --repository testpypi
-```
-To publish to PyPI itself, just omit the `--repository` argument.
-
 ## Design constraints
 
 There are some weird aspects about GitHub's design which lead to unusual

ghstack-0.9.4/PKG-INFO → ghstack-0.9.5/README.md

@@ -1,28 +1,3 @@
-Metadata-Version: 2.1
-Name: ghstack
-Version: 0.9.4
-Summary: Stack diff support for GitHub
-Home-page: https://github.com/ezyang/ghstack
-License: MIT
-Author: Edward Z. Yang
-Author-email: ezyang@mit.edu
-Requires-Python: >=3.8.1,<4.0.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: aiohttp (>=3,<4)
-Requires-Dist: click (>=8,<9)
-Requires-Dist: flake8 (>=7.0.0,<8.0.0)
-Requires-Dist: importlib-metadata (>=1.4) ; python_version < "3.8"
-Requires-Dist: requests (>=2,<3)
-Requires-Dist: typing-extensions (>=3,<5)
-Project-URL: Repository, https://github.com/ezyang/ghstack
-Description-Content-Type: text/markdown
-
 # ghstack
 
 Conveniently submit stacks of diffs to GitHub as separate pull requests.
@@ -76,7 +51,11 @@ 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` to land a ghstack'ed pull request.
+`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.
+https://github.com/Chillee/ghstack_land_example/blob/main/.github/workflows/issue_comment.yml is an end-to-end example of how to do this.
 
 ## Structure of submitted pull requests
 
@@ -98,51 +77,6 @@ pull request and pushes commits onto three branches:
   want to work on the commits from another machine, this is the best way
   to get it.
 
-## Developer notes
-
-This project uses [Poetry](https://python-poetry.org/docs/#installation), so
-after you've installed Poetry itself, run this command in your clone of this
-repo to install all the dependencies you need for working on `ghstack`:
-```
-poetry install
-```
-Note that this installs the dependencies (and `ghstack` itself) in an isolated
-Python virtual environment rather than globally. If your cwd is in your clone of
-this repo then you can run your locally-built `ghstack` using `poetry run
-ghstack $ARGS`, but if you want to run it from somewhere else, you probably want
-[`poetry shell`](https://python-poetry.org/docs/cli/#shell) instead:
-```
-poetry shell
-cd $SOMEWHERE
-ghstack $ARGS
-```
-
-### Testing
-
-We have tests, using a mock GitHub GraphQL server!  How cool is that?
-```
-poetry run python test_ghstack.py
-```
-That runs most of the tests; you can run all tests (including lints) like this:
-```
-poetry run python run_tests.py
-```
-
-### Publishing
-
-You can also [use Poetry to
-publish](https://python-poetry.org/docs/cli/#publish) to a package repository.
-For instance, if you've configured your [Poetry
-repositories](https://python-poetry.org/docs/repositories/) like this:
-```
-poetry config repositories.testpypi https://test.pypi.org/legacy/
-```
-Then you can publish to TestPyPI like this:
-```
-poetry publish --build --repository testpypi
-```
-To publish to PyPI itself, just omit the `--repository` argument.
-
 ## Design constraints
 
 There are some weird aspects about GitHub's design which lead to unusual
@@ -189,4 +123,3 @@ So, this is not impossible to do, but it will need some work.
 You have to work out what the real base commit is, whether
 or not you need to advance it, and also rewrite the stack rendering
 code.
-

ghstack-0.9.5/pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+authors = [
+    {name = "Edward Z. Yang", email = "ezyang@mit.edu"},
+]
+license = {text = "MIT"}
+requires-python = "<4.0.0,>=3.8.1"
+dependencies = [
+    "aiohttp<4,>=3",
+    "importlib-metadata>=1.4; python_version < \"3.8\"",
+    "requests<3,>=2",
+    "typing-extensions>=3",
+    "click<9,>=8",
+    "flake8<8.0.0,>=7.0.0",
+]
+name = "ghstack"
+version = "0.9.5"
+description = "Stack diff support for GitHub"
+readme = "README.md"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+repository = "https://github.com/ezyang/ghstack"
+
+[project.scripts]
+ghstack = "ghstack.cli:main"
+
+[dependency-groups]
+dev = [
+    "black<25.0.0,>=24.3.0",
+    "flake8<8,>=7",
+    "graphql-core<4,>=3",
+    "hypothesis<7,>=6",
+    "mypy<2,>=1",
+    "pytest<8,>=7",
+    "usort<2,>=1",
+    "ufmt<3,>=2",
+    "lintrunner<1.0.0,>=0.11.0",
+    "types-requests<3.0.0.0,>=2.31.0.10",
+    "pytest-xdist<4.0.0,>=3.5.0",
+    "expecttest<1.0.0,>=0.2.0",
+]
+
+[build-system]
+requires = ["uv_build>=0.6,<0.7"]
+build-backend = "uv_build"

{ghstack-0.9.4 → ghstack-0.9.5/src}/ghstack/action.py

@@ -26,7 +26,7 @@ def main(
             }
         }
     """,
-        **params
+        **params,
     )
     pr_id = pr_result["data"]["repository"]["pullRequest"]["id"]
 

{ghstack-0.9.4 → ghstack-0.9.5/src}/ghstack/checkout.py

@@ -15,7 +15,9 @@ def main(
     remote_name: str,
 ) -> None:
 
-    params = ghstack.github_utils.parse_pull_request(pull_request)
+    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:

{ghstack-0.9.4 → ghstack-0.9.5/src}/ghstack/diff.py

@@ -14,7 +14,7 @@ RE_GH_METADATA = re.compile(
 
 
 RAW_PULL_REQUEST_RESOLVED = (
-    r"Pull Request resolved: "
+    r"(Pull Request resolved|Pull-Request-resolved): "
     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-resolved'.  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.9.4 → ghstack-0.9.5/src}/ghstack/forensics.py

@@ -73,7 +73,7 @@ async def main(
         }
     }
     """,
-        **params
+        **params,
     )
     nodes = r["data"]["repository"]["pullRequest"]["commits"]["nodes"]
 

{ghstack-0.9.4 → ghstack-0.9.5/src}/ghstack/github.py

@@ -38,7 +38,7 @@ class GitHubEndpoint(metaclass=ABCMeta):
                 }
             }
         """,
-            **params
+            **params,
         )
         r = pr_result["data"]["repository"]["pullRequest"]["headRefName"]
         assert isinstance(r, str), type(r)

{ghstack-0.9.4 → ghstack-0.9.5/src}/ghstack/github_utils.py

@@ -115,9 +115,23 @@ GitHubPullRequestParams = TypedDict(
 )
 
 
-def parse_pull_request(pull_request: str) -> GitHubPullRequestParams:
+def parse_pull_request(
+    pull_request: str,
+    *,
+    sh: Optional[ghstack.shell.Shell] = None,
+    remote_name: Optional[str] = None,
+) -> GitHubPullRequestParams:
     m = RE_PR_URL.match(pull_request)
     if not m:
+        # We can reconstruct the URL if just a PR number is passed
+        if sh is not None and remote_name is not None:
+            remote_url = sh.git("remote", "get-url", remote_name)
+            # Do not pass the shell to avoid infinite loop
+            try:
+                return parse_pull_request(remote_url + "/pull/" + pull_request)
+            except RuntimeError:
+                # Fall back on original error message
+                pass
         raise RuntimeError("Did not understand PR argument.  PR must be URL")
 
     github_url = m.group("github_url")

{ghstack-0.9.4 → ghstack-0.9.5/src}/ghstack/land.py

@@ -57,7 +57,9 @@ def main(
     # Furthermore, the parent commits of PR are ignored: we always
     # take the canonical version of the patch from any given pr
 
-    params = ghstack.github_utils.parse_pull_request(pull_request)
+    params = ghstack.github_utils.parse_pull_request(
+        pull_request, sh=sh, remote_name=remote_name
+    )
     default_branch = ghstack.github_utils.get_github_repo_info(
         github=github,
         sh=sh,

{ghstack-0.9.4 → ghstack-0.9.5/src}/ghstack/shell.py

@@ -92,7 +92,7 @@ class Shell(object):
         stdin: _HANDLE = None,
         stdout: _HANDLE = subprocess.PIPE,
         exitcode: bool = False,
-        tick: bool = False
+        tick: bool = False,
     ) -> _SHELL_RET:
         """
         Run a command specified by args, and return string representing

{ghstack-0.9.4 → ghstack-0.9.5/src}/ghstack/status.py

@@ -77,7 +77,7 @@ async def main(
         }
     }
     """,
-        **params
+        **params,
     )
     contexts = r["data"]["repository"]["pullRequest"]["commits"]["nodes"][0]["commit"][
         "status"

{ghstack-0.9.4 → ghstack-0.9.5/src}/ghstack/submit.py

@@ -815,7 +815,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-resolved' and then run ghexport again.
 """
             )
 
@@ -832,7 +832,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-resolved' and then run ghexport again.
 """
                 )
             else:
@@ -963,17 +963,20 @@ to disassociate the commit with the pull request, and then try again.
             commit_msg = self._update_source_id(diff.summary, elab_diff)
         else:
             # Need to insert metadata for the first time
-            commit_msg = "".join(
-                [
-                    f"{strip_mentions(diff.summary.rstrip())}\n\n",
-                    f"ghstack-source-id: {diff.source_id}\n",
-                    (
-                        f"ghstack-comment-id: {elab_diff.comment_id}\n"
-                        if self.direct
-                        else ""
-                    ),
-                    f"Pull Request resolved: {pull_request_resolved.url()}",
-                ]
+            # TODO: Probably quicker if we reimplement reinterpret-trailers
+            # in Python
+            commit_msg = self.sh.git(
+                "interpret-trailers",
+                "--trailer",
+                f"ghstack-source-id: {diff.source_id}",
+                *(
+                    ["--trailer", f"ghstack-comment-id: {elab_diff.comment_id}"]
+                    if self.direct
+                    else []
+                ),
+                "--trailer",
+                f"Pull-Request-resolved: {pull_request_resolved.url()}",
+                input=strip_mentions(diff.summary.rstrip()),
             )
 
         return DiffMeta(
@@ -1476,6 +1479,30 @@ is closed (likely due to being merged).  Please rebase to upstream and try again
         push_branches: List[str] = []
         force_push_branches: List[str] = []
 
+        for s in reversed(diffs_to_submit):
+            # It is VERY important that we do base updates BEFORE real
+            # head updates, otherwise GitHub will spuriously think that
+            # the user pushed a number of patches as part of the PR,
+            # when actually they were just from the (new) upstream
+            # branch
+
+            for diff, b in s.push_branches:
+                if b == "orig":
+                    q = force_push_branches
+                elif b == "base":
+                    q = base_push_branches
+                else:
+                    q = push_branches
+                q.append(push_spec(diff, branch(s.username, s.ghnum, b)))
+        # Careful!  Don't push master.
+        # TODO: These pushes need to be atomic (somehow)
+        if base_push_branches:
+            self._git_push(base_push_branches)
+        if push_branches:
+            self._git_push(push_branches, force=self.force)
+        if force_push_branches:
+            self._git_push(force_push_branches, force=True)
+
         for s in reversed(diffs_to_submit):
             # NB: GraphQL API does not support modifying PRs
             assert not s.closed
@@ -1513,29 +1540,6 @@ is closed (likely due to being merged).  Please rebase to upstream and try again
                     body=stack_desc,
                 )
 
-            # It is VERY important that we do base updates BEFORE real
-            # head updates, otherwise GitHub will spuriously think that
-            # the user pushed a number of patches as part of the PR,
-            # when actually they were just from the (new) upstream
-            # branch
-
-            for diff, b in s.push_branches:
-                if b == "orig":
-                    q = force_push_branches
-                elif b == "base":
-                    q = base_push_branches
-                else:
-                    q = push_branches
-                q.append(push_spec(diff, branch(s.username, s.ghnum, b)))
-        # Careful!  Don't push master.
-        # TODO: These pushes need to be atomic (somehow)
-        if base_push_branches:
-            self._git_push(base_push_branches)
-        if push_branches:
-            self._git_push(push_branches)
-        if force_push_branches:
-            self._git_push(force_push_branches, force=True)
-
         # Report what happened
         def format_url(s: DiffMeta) -> str:
             return "https://{github_url}/{owner}/{repo}/pull/{number}".format(
@@ -1797,6 +1801,7 @@ is closed (likely due to being merged).  Please rebase to upstream and try again
             self.sh.git(
                 "push",
                 self.remote_name,
+                "--no-verify",
                 *(["--force"] if force else []),
                 *branches,
             )

ghstack-0.9.4/LICENSE

@@ -1,19 +0,0 @@
-Copyright (c) Edward Z. Yang <ezyang@mit.edu>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

ghstack-0.9.4/ghstack/inbox.py

@@ -1,7 +0,0 @@
-import ghstack.github
-import json
-
-def main(
-    github: ghstack.github.GitHubEndpoint,
-) -> None:
-    print(json.dumps(github.get("notifications")))

ghstack-0.9.4/pyproject.toml

@@ -1,44 +0,0 @@
-[tool.poetry]
-name = "ghstack"
-version = "0.9.4"
-authors = ["Edward Z. Yang <ezyang@mit.edu>"]
-description = "Stack diff support for GitHub"
-readme = "README.md"
-repository = "https://github.com/ezyang/ghstack"
-include = ["ghstack/py.typed"]
-license = "MIT"
-classifiers = [
-    "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: MIT License",
-    "Operating System :: OS Independent",
-]
-
-[tool.poetry.scripts]
-ghstack = "ghstack.cli:main"
-
-[tool.poetry.dependencies]
-aiohttp = "^3"
-importlib-metadata = { version = ">=1.4", python = "<3.8" }
-python = "^3.8.1"
-requests = "^2"
-typing-extensions = ">=3 <5"
-click = "^8"
-flake8 = "^7.0.0"
-
-[tool.poetry.dev-dependencies]
-black = "^24.3.0"
-flake8 = "^7"
-graphql-core = "^3"
-hypothesis = "^6"
-mypy = "^1"
-pytest = "^7"
-usort = "^1"
-ufmt = "^2"
-lintrunner = "^0.11.0"
-types-requests = "^2.31.0.10"
-pytest-xdist = "^3.5.0"
-expecttest = "^0.2.0"
-
-[build-system]
-requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"