github2gerrit 2.0.0__tar.gz → 2.1.1__tar.gz

{github2gerrit-2.0.0 → github2gerrit-2.1.1}/.pre-commit-config.yaml

@@ -64,20 +64,38 @@ repos:
         types: [yaml]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 65dbdb59d2f2d9c3bdc343c566821ad3319ddaa3  # frozen: v0.16.3
+    rev: 1f1e8bf348ff38fc88619a38d3ca4d9c56abea49  # frozen: v0.16.5
     hooks:
       - id: ruff
-        files: ^(src|scripts|tests)/.+\.py$
+        files: ^(src|scripts|tests)/.+\.py$|^sitecustomize\.py$
         args: [--fix, --exit-non-zero-on-fix]
       - id: ruff-format
-        files: ^(src|scripts|tests)/.+\.py$
+        files: ^(src|scripts|tests)/.+\.py$|^sitecustomize\.py$
 
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: 7ff8d35ae36a7d2b968f2f90b4c723e292e594ee  # frozen: v2.3.1
     hooks:
       - id: mypy
-        files: ^src/.+\.py$
+        # Every Python path in the repository, matching the ruff and
+        # basedpyright hooks above and below so the three cannot drift.
+        files: ^(src|scripts|tests)/.+\.py$|^sitecustomize\.py$
+        # mypy runs in an isolated virtualenv that holds only what is
+        # listed here, so anything the checked files import has to be
+        # present or mypy draws conclusions the project never would. With
+        # pytest absent, for instance, @pytest.fixture reads as an untyped
+        # decorator and pytest.raises stops telling mypy the block can
+        # swallow the exception, which turns every statement after a
+        # `with pytest.raises(...)` into dead code. Installing the real
+        # packages removes that whole class of environment-only findings;
+        # keep this list in step with the imports under src/ and tests/.
+        # pygerrit2 is deliberately absent: it is an optional runtime
+        # dependency and pyproject.toml already gives it
+        # ignore_missing_imports.
         additional_dependencies:
+          - click>=8.2
+          - pytest
+          - responses
+          - typer
           - types-PyYAML
           - types-requests
 
@@ -89,7 +107,7 @@ repos:
         args: ["--no-adverb"]
 
   - repo: https://github.com/shellcheck-py/shellcheck-py
-    rev: 745eface02aef23e168a8afb6b5737818efbea95  # frozen: v0.11.0.1
+    rev: a6564f5d57444e123433a5c9af733e3975c77229  # frozen: v0.11.0.1-1
     hooks:
       - id: shellcheck
 
@@ -123,10 +141,12 @@ repos:
     rev: 3c94d276aa3005fa1f5a977946c9dc106135c083  # frozen: 1.39.10
     hooks:
       - id: basedpyright
-        files: ^src/.+\.py$
+        # Every Python path in the repository. Keep in sync with the
+        # `include` list under [tool.pyright] in pyproject.toml.
+        files: ^(src|scripts|tests)/.+\.py$|^sitecustomize\.py$
 
   - repo: https://github.com/lfreleng-actions/gha-workflow-linter
-    rev: 7f11ad46be1cd2b3d778428d40fcb09309bb3be5  # frozen: v1.4.1
+    rev: cae470a1e8988c3cacbe9cc40a0d6b8e6881bde2  # frozen: v1.5.5
     hooks:
       - id: gha-workflow-linter
 

github2gerrit-2.1.1/LICENSES/Apache-2.0.txt

@@ -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.

{github2gerrit-2.0.0 → github2gerrit-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: github2gerrit
-Version: 2.0.0
+Version: 2.1.1
 Summary: Submit a GitHub pull request to a Gerrit repository.
 Project-URL: Homepage, https://github.com/lfreleng-actions/github2gerrit-action
 Project-URL: Repository, https://github.com/lfreleng-actions/github2gerrit-action
@@ -22,7 +22,6 @@ Classifier: Topic :: Software Development :: Build Tools
 Classifier: Topic :: Software Development :: Version Control
 Classifier: Typing :: Typed
 Requires-Python: >=3.11
-Requires-Dist: click>=8.1.7
 Requires-Dist: cryptography>=48.0.1
 Requires-Dist: git-review>=2.5.0
 Requires-Dist: pygerrit2>=2.0.15
@@ -33,6 +32,7 @@ Requires-Dist: rich>=14.2.0
 Requires-Dist: typer>=0.20.1
 Requires-Dist: urllib3>=2.6.3
 Provides-Extra: dev
+Requires-Dist: click>=8.2; extra == 'dev'
 Requires-Dist: coverage[toml]>=7.10.6; extra == 'dev'
 Requires-Dist: mypy>=1.17.1; extra == 'dev'
 Requires-Dist: pytest-cov>=7.0.0; extra == 'dev'
@@ -40,6 +40,7 @@ Requires-Dist: pytest-mock>=3.15.1; extra == 'dev'
 Requires-Dist: pytest>=9.0.2; extra == 'dev'
 Requires-Dist: responses>=0.25.8; extra == 'dev'
 Requires-Dist: ruff>=0.6.3; extra == 'dev'
+Requires-Dist: types-pyyaml>=6.0.12; extra == 'dev'
 Requires-Dist: types-requests>=2.31.0; extra == 'dev'
 Requires-Dist: types-urllib3>=1.26.25.14; extra == 'dev'
 Description-Content-Type: text/markdown
@@ -139,6 +140,9 @@ name: github2gerrit
 on:
   pull_request_target:
     types: [opened, reopened, edited, synchronize, closed]
+  # Re-runs when a maintainer approves a fork pull request
+  pull_request_review:
+    types: [submitted, dismissed]
   push:
     branches: [main, master]
   workflow_dispatch:
@@ -186,6 +190,9 @@ name: github2gerrit
 on:
   pull_request_target:
     types: [opened, reopened, edited, synchronize, closed]
+  # Re-runs when a maintainer approves a fork pull request
+  pull_request_review:
+    types: [submitted, dismissed]
   workflow_dispatch:
 
 permissions:

{github2gerrit-2.0.0 → github2gerrit-2.1.1}/README.md

@@ -93,6 +93,9 @@ name: github2gerrit
 on:
   pull_request_target:
     types: [opened, reopened, edited, synchronize, closed]
+  # Re-runs when a maintainer approves a fork pull request
+  pull_request_review:
+    types: [submitted, dismissed]
   push:
     branches: [main, master]
   workflow_dispatch:
@@ -140,6 +143,9 @@ name: github2gerrit
 on:
   pull_request_target:
     types: [opened, reopened, edited, synchronize, closed]
+  # Re-runs when a maintainer approves a fork pull request
+  pull_request_review:
+    types: [submitted, dismissed]
   workflow_dispatch:
 
 permissions:

{github2gerrit-2.0.0 → github2gerrit-2.1.1}/docs/cli.md

@@ -165,6 +165,7 @@ Some settings have no CLI flag and use environment variables:
 | `G2G_LOG_LEVEL`               | `WARNING`                                   | Logging level; set `DEBUG` for verbose output                                    |
 | `G2G_TOPIC_PREFIX`            | `GH`                                        | Prefix used when generating Gerrit topics                                        |
 | `G2G_SKIP_GERRIT_COMMENTS`    | `false`                                     | Skip posting back-reference comments on Gerrit changes                           |
+| `G2G_TRUSTED_ASSOCIATIONS`    | `OWNER,MEMBER,COLLABORATOR`                 | Author associations trusted to issue `@github2gerrit` comment directives         |
 | `G2G_ENABLE_DERIVATION`       | `true`                                      | Enable automatic derivation of Gerrit parameters from organization defaults      |
 | `G2G_AUTO_SAVE_CONFIG`        | context-dependent                           | Save derived parameters back to the configuration file                           |
 | `G2G_RESPECT_USER_SSH`        | `false` (`true` in direct URL mode)         | Use the local user's SSH configuration and keys instead of provided key material |

{github2gerrit-2.0.0 → github2gerrit-2.1.1}/docs/features.md

@@ -102,6 +102,57 @@ acts on it during the next workflow run.
 - When the same command appears in more than one comment, only the latest
   occurrence takes effect.
 - The tool logs unrecognized directives at debug level and ignores them.
+- Only comments from trusted authors count. See below.
+
+### Who May Issue Commands
+
+These repositories are public, so the tool checks who wrote a comment before
+acting on it. Without that check, any GitHub user able to leave a comment
+could direct the tool.
+
+A comment counts only when GitHub reports its author's `author_association`
+as one of:
+
+| Association    | Meaning                                    |
+| -------------- | ------------------------------------------ |
+| `OWNER`        | Owns the repository                        |
+| `MEMBER`       | Member of the owning organization          |
+| `COLLABORATOR` | Invited collaborator on the repository     |
+
+`CONTRIBUTOR` is **not** trusted. It means only that the author has had a
+pull request merged at some point, which any outside contributor can achieve
+and which carries no authority.
+
+The tool ignores directives from anyone else and logs a warning naming the
+author and their association, so a refused command is visible rather than
+silently dropped.
+
+#### For contributors adding commands
+
+Adding a `CommandDefinition` to the registry gives the new command the same
+authorisation as the existing one, so long as consumers reach it through
+`github2gerrit.pr_directives`, which fetches comments, discards untrusted
+authors and parses in a single step.
+
+The parsing module performs no authorisation of its own. Calling
+`parse_commands`, `find_command` or `has_command` with comments taken straight
+from the GitHub API skips the check and recreates the original defect.
+
+Override the trusted set with `G2G_TRUSTED_ASSOCIATIONS`, a comma-separated
+list. Setting it to `OWNER` alone is the strictest useful value:
+
+```yaml
+env:
+  G2G_TRUSTED_ASSOCIATIONS: "OWNER,MEMBER"
+```
+
+An empty or blank value keeps the default rather than trusting nobody or
+everyone.
+
+Note that `MEMBER` means organization member, which is not the same as write
+access to a given repository. On a Gerrit mirror that remains the only
+available signal, because the GitHub collaborator list holds infrastructure
+accounts rather than the project's reviewers.
 
 ### Available Commands
 
@@ -349,9 +400,87 @@ Same-repository pull requests keep their previous behaviour and still read
 
 ### Approval gating
 
-The tool does not yet require a maintainer approval before it transfers a fork
-pull request to Gerrit. Until it does, use `AUTOMATION_ONLY` (see above) to
-control which pull requests the tool accepts.
+A fork pull request does not transfer to Gerrit until a maintainer approves it.
+The check runs before the tool fetches anything from the pull request and before
+it unlocks the Gerrit SSH key, so a pull request awaiting review reaches
+neither.
+
+Same-repository pull requests skip the check entirely. Pushing a branch to the
+base repository already requires write access, and automation such as
+Dependabot, pre-commit.ci and Copilot works that way, so the gate never affects
+them.
+
+#### What counts as approval
+
+An approving review, where every one of the following holds:
+
+- the reviewer's `author_association` falls in the trusted set, the same one
+  used for [comment commands](#who-may-issue-commands);
+- the review targets the pull request's **current head commit**;
+- no trusted reviewer has since requested changes; and
+- the reviewer is not the pull request author.
+
+A pull request whose provenance the tool cannot establish takes the same path as
+a fork. Approval is a question about authority, and an absent signal is not an
+answer.
+
+The gate applies to unattended runs. Running the CLI directly against a pull
+request URL does not require an approval: the operator chose that pull request
+and is using their own credentials, so they are already the authority the gate
+looks for. It exists for the automated path, where the tool acts on a shared
+identity with nobody watching.
+
+Binding to the head commit matters. GitHub keeps approvals across pushes unless
+branch protection dismisses them, so an approval that was not checked against a
+commit would let a contributor gain approval for one revision and then push a
+different one. The cost is that maintainers re-approve after each push, which is
+the correct trade.
+
+The author exclusion is belt and braces. GitHub already rejects approving your
+own pull request, and that guarantee is a large part of why the tool uses
+reviews rather than comment directives — on a Gerrit mirror the pull request
+author often holds the same organization membership as the reviewers.
+
+#### Enabling re-runs on approval
+
+`pull_request_target` carries no event for a submitted review, so approving a
+pull request does nothing unless the calling workflow listens for it:
+
+```yaml
+on:
+  pull_request_target:
+    types: [opened, reopened, edited, synchronize, closed]
+  pull_request_review:
+    types: [submitted, dismissed]
+```
+
+Without that trigger the tool only reconsiders a pull request on its next
+push, or when a maintainer dispatches the workflow by hand.
+
+#### When the gate blocks
+
+The run finishes successfully rather than failing. A pull request waiting for a
+human is not broken, and a red check would suggest otherwise.
+
+The tool posts one comment explaining what is missing, and edits that same
+comment on later runs rather than adding another. Where an approval exists but
+covers an earlier commit, the comment says so, so a maintainer who did approve
+is not told that nobody has.
+
+Once approval arrives, the tool edits that comment again to record it, so a
+transferred pull request does not keep displaying a stale block.
+
+#### If the head moves mid-run
+
+The gate reads the head commit from the API, while the workspace fetch reads
+`refs/pull/<N>/head`, which the contributor can move meanwhile. The tool
+compares the commit it fetched against the commit the maintainer approved and
+refuses a mismatch, so a push timed against a running workflow cannot slip an
+unreviewed commit into Gerrit.
+
+That refusal fails the run, unlike the ordinary blocked case, because it falls
+outside the normal course of events. The push that caused it triggers a fresh
+run, which asks for approval of the new commit in the usual way.
 
 ## Duplicate Detection