patch-via-github 1.0.0__py3-none-any.whl

patch_via_github-1.0.0.dist-info/METADATA

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: patch-via-github
+Version: 1.0.0
+Summary: Tool used to modify a local 'repo sync' with changes from GitHub pull requests
+Requires-Python: ==3.14.*
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests==2.34.2
+Requires-Dist: urllib3==2.8.0
+
+# patch\_via\_github
+
+`patch_via_github` is a command-line tool for applying GitHub pull request
+changes to a [`repo sync`](https://source.android.com/docs/setup/download/downloading)
+workspace. It automates the process of fetching and cherry-picking (or checking
+out) PRs from GitHub, with manifest-aware project resolution.
+
+This is the GitHub counterpart to
+[`patch_via_gerrit`](https://github.com/couchbase/patch_via_gerrit). The two
+tools can be used together on the same `repo sync` workspace — each targets
+its own set of PRs/reviews independently.
+
+## Installation
+
+The easiest way to run `patch_via_github` is with `uvx`, which needs no
+separate install step:
+
+```bash
+uvx patch_via_github -p couchbase/tlm#42
+```
+
+Alternatively, install it persistently with `uv`:
+
+```bash
+uv tool install patch-via-github
+```
+
+This will install `patch_via_github` to `~/.local/bin/`. Make sure this
+directory is on your `PATH`.
+
+## Configuration
+
+Before using `patch_via_github`, create a configuration file with your GitHub
+credentials. By default, the tool looks for `~/.ssh/patch_via_github.ini`:
+
+```ini
+[main]
+token = ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+default_org = couchbase
+```
+
+| Key | Required | Description |
+|---|---|---|
+| `token` | Yes | GitHub personal access token (see below) |
+| `default_org` | No | Default GitHub org for short-form PR references (`repo#123`) |
+| `ssh` | No | Fetch over SSH (default `true`); `--no-ssh` on the command line takes precedence |
+
+An example config is provided in
+[`patch_via_github.ini.example`](patch_via_github.ini.example).
+
+You can also specify a custom config file location with the `-c/--config`
+option.
+
+### Creating a GitHub Personal Access Token
+
+Use a classic token: a single build can involve private repositories in more
+than one organization (e.g. `couchbase` and `couchbaselabs`), and a
+fine-grained token can only access one. To create one:
+
+1. Go to **GitHub → Settings → Developer settings →
+   [Personal access tokens → Tokens (classic)](https://github.com/settings/tokens/new)**
+2. Give the token a descriptive name (e.g. `patch_via_github`)
+3. Set the **Expiration** as appropriate for your use case
+4. Select the **`repo`** scope (needed to read pull requests on private
+   repositories)
+5. Click **Generate token** and copy the value into your config file
+6. Authorize the token for single sign-on: in the
+   [list of classic tokens](https://github.com/settings/tokens), click
+   **Configure SSO** next to it and **Authorize** each organization you'll be
+   patching from
+
+Without step 6, GitHub refuses requests for repositories in SSO-protected
+organizations.
+
+## Usage
+
+By default, `patch_via_github` operates on the current directory. You can either
+navigate to your `repo sync` workspace first, or use the `-s/--source` option to
+specify the workspace location.
+
+### Apply Patches by PR Reference
+
+Apply one or more specific pull requests:
+
+```bash
+patch_via_github -p couchbase/tlm#42
+patch_via_github -p couchbase/tlm#42,couchbase/ns_server#108
+patch_via_github --pull-request couchbase/tlm#42 couchbase/server-ui#7
+```
+
+Short-form references use the `default_org` from your config (or `-o`):
+
+```bash
+patch_via_github -o couchbase -p tlm#42,ns_server#108
+```
+
+### Apply Patches by Label
+
+Apply all open PRs matching a label on a given repo:
+
+```bash
+patch_via_github -l couchbase/tlm:backport
+patch_via_github -l couchbase/tlm:backport,couchbase/ns_server:ci-test
+```
+
+### Checkout vs Cherry-Pick
+
+By default, each PR's commits are cherry-picked in order onto the project's
+current checkout. This requires linear PR history: a PR containing merge
+commits is rejected, and should be rebased or applied with `-C/--checkout`,
+which checks out the PR head instead:
+
+```bash
+patch_via_github -C -p couchbase/tlm#42
+```
+
+### Debug Output
+
+```bash
+patch_via_github -d -p couchbase/tlm#42
+```
+
+## How It Works
+
+`patch_via_github` automates several tasks:
+
+1. **PR Resolution:** When you specify PRs by reference or label, the tool
+   fetches their metadata from the GitHub API and filters based on state and
+   branch.
+
+2. **Branch Filtering:** PRs found by label are only applied if they are open
+   and their target branch matches the manifest's revision for that project
+   (unless the manifest revision is a SHA). PRs requested by reference are
+   applied whatever their state or target branch.
+
+3. **Ordering:** PRs are applied in the order given on the command line. PRs
+   found by label are applied label by label in the order the labels were
+   given, and in PR number order (oldest first) within each label. A PR that
+   appears more than once is applied once, at its first position.
+
+4. **Verification:** The tool verifies that all explicitly-requested PRs were
+   successfully applied.
+
+5. **Rollback:** If anything fails, every project the run touched is returned
+   to the commit (and branch) it was on beforehand; uncommitted local changes
+   are kept.
+
+Changes to the `manifest` repository are reviewed on Gerrit, so apply those
+with [`patch_via_gerrit`](https://github.com/couchbase/patch_via_gerrit).
+
+GitHub API requests are retried on transient errors (HTTP 429/5xx), and `git
+fetch` times out after 10 minutes.
+
+## Command-Line Options
+
+```
+patch_via_github [options]
+
+Required (mutually exclusive):
+  -p, --pull-request PR [PR ...]  PR references to apply (comma-separated)
+                                  Format: org/repo#number or repo#number
+  -l, --label LABEL [LABEL ...]   Labels to search for open PRs (comma-separated)
+                                  Format: org/repo:label
+
+Options:
+  -d, --debug                     Enable debugging output
+  -c, --config FILE               Configuration file (default: ~/.ssh/patch_via_github.ini)
+  -s, --source DIR                Location of repo sync checkout (default: current directory)
+  -o, --default-org ORG           Default GitHub org for short-form PR references
+  -C, --checkout                  Checkout PR head instead of cherry-picking
+  --no-ssh                        Fetch over HTTPS instead of SSH
+  -V, --version                   Display version information
+```
+
+## Troubleshooting
+
+**"Configuration file missing":**
+- Create `~/.ssh/patch_via_github.ini` with your GitHub credentials
+- Or specify a custom location with `-c/--config`
+
+**"Project missing on disk":**
+- Ensure you've run `repo sync` before applying patches
+- The PR may reference a project not in your manifest groups
+
+**"Failed to apply all explicitly-requested PRs":**
+- The PR's project is not in the manifest, or is excluded by your manifest
+  groups (look for "ignoring PR" earlier in the output)
+- Try running with `--debug` to see more details
+
+## Running Tests
+
+```bash
+uv run pytest
+```
+

patch_via_github-1.0.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+patch_via_github/__init__.py,sha256=wX7iy3K3Bm6KphgcQHk-TC7Bv6Y0bJE4EapQYdOGVaA,349
+patch_via_github/scripts/__init__.py,sha256=gnJtW06a4w4hY1HJ8ZhZP_ksd9Gj8cLegFoQzC2TvHA,43
+patch_via_github/scripts/main.py,sha256=l2roXt4w3ILxp5jdOkIFE4uuL1Cdb_5rVMi2uwLC6dI,34937
+patch_via_github/tests/__init__.py,sha256=qQX8uVadhPG39qzcGLdYgGiGpKUgqKT3gGewOgP1OVU,39
+patch_via_github/tests/conftest.py,sha256=DkuwAxQ4xCxZiB12X1HFDhEM2cnsnRbdayJnvXB6sTc,6312
+patch_via_github/tests/manifest.xml,sha256=Z4wmi_1TO2WvZuMhMsQ9EVy3PtF-9UyJwyC5DLaYzK0,794
+patch_via_github/tests/test_patch_via_github.py,sha256=9kFmYORZY3LyyvqtIi07AYLB9cAjKi1ju3kWNCzhyYA,66649
+patch_via_github-1.0.0.dist-info/entry_points.txt,sha256=spe6LJty04YDfYsaBsFeGEvB6LCPyYaAeZvVPuCtGtY,71
+patch_via_github-1.0.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+patch_via_github-1.0.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+patch_via_github-1.0.0.dist-info/METADATA,sha256=zCXRj-jElt7Lec88rUT_yIXU3n14EDmH4ITg6LziK2k,7035
+patch_via_github-1.0.0.dist-info/RECORD,,

patch_via_github-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: flit 3.12.0
+Root-Is-Purelib: true
+Tag: py3-none-any

patch_via_github-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+patch_via_github=patch_via_github.scripts.main:main
+

patch_via_github-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.