git-commit-guard 0.22.2__py3-none-any.whl → 0.23.0__py3-none-any.whl

git_commit_guard/__init__.py

@@ -146,6 +146,10 @@ class Result:
     def ok(self):
         return not any(lvl == Level.ERROR for _, lvl, _ in self.errors)
 
+    @property
+    def noteworthy(self):
+        return any(lvl in (Level.ERROR, Level.WARN) for _, lvl, _ in self.errors)
+
 
 def _ensure_nltk_data():
     _download_if_missing("taggers/averaged_perceptron_tagger_eng")
@@ -295,9 +299,9 @@ def check_required_trailers(message, required, result):
             result.error(f"missing required trailer: {trailer}")
 
 
-def _get_author_email(rev):
+def _get_committer_email(rev):
     return subprocess.check_output(  # noqa: S603
-        ["git", "log", "-1", "--format=%ae", rev],  # noqa: S607
+        ["git", "log", "-1", "--format=%ce", rev],  # noqa: S607
         text=True,
         stderr=subprocess.PIPE,
         timeout=_git_timeout(),
@@ -320,7 +324,7 @@ def _get_github_remote_info():
     return match.group("owner"), match.group("repo")
 
 
-def _fetch_github_commit_author(owner, repo, sha):
+def _fetch_github_commit_committer(owner, repo, sha):
     url = f"https://api.github.com/repos/{owner}/{repo}/commits/{sha}"
     headers = {"Accept": "application/vnd.github+json"}
     token = os.environ.get("GITHUB_TOKEN") or os.environ.get("GH_TOKEN")
@@ -329,8 +333,8 @@ def _fetch_github_commit_author(owner, repo, sha):
     req = urllib.request.Request(url, headers=headers)  # noqa: S310 Audit URL open for permitted schemes
     with urllib.request.urlopen(req, timeout=_git_timeout()) as resp:  # noqa: S310 Audit URL open for permitted schemes
         data = json.loads(resp.read())
-    author = data.get("author")
-    return author["login"] if author else None
+    committer = data.get("committer")
+    return committer["login"] if committer else None
 
 
 def _parse_noreply_username(email):
@@ -435,7 +439,7 @@ def _resolve_github_username(rev, email):
     if remote:
         owner, repo = remote
         try:
-            username = _fetch_github_commit_author(owner, repo, rev)
+            username = _fetch_github_commit_committer(owner, repo, rev)
         except urllib.error.HTTPError as e:
             if e.code == HTTPStatus.NOT_FOUND:
                 commits_api_404 = True
@@ -450,24 +454,24 @@ def _resolve_github_username(rev, email):
     return username, commits_api_404
 
 
-def _author_not_found_message(commits_api_404):
+def _committer_not_found_message(commits_api_404):
     had_token = bool(os.environ.get("GITHUB_TOKEN") or os.environ.get("GH_TOKEN"))
     if commits_api_404 and not had_token:
         return (
-            "commit author not found on GitHub — if the repo is private, "
+            "committer not found on GitHub — if the repo is private, "
             "set GITHUB_TOKEN in the workflow step "
             "(env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }})"
         )
-    return "commit author not found on GitHub — cannot verify signature"
+    return "committer not found on GitHub — cannot verify signature"
 
 
 def check_signature(rev, result):
     try:
-        email = _get_author_email(rev)
+        email = _get_committer_email(rev)
         username, commits_api_404 = _resolve_github_username(rev, email)
         if username is None:
             result.error(
-                _author_not_found_message(commits_api_404),
+                _committer_not_found_message(commits_api_404),
                 check=Check.SIGNATURE,
             )
             return
@@ -565,6 +569,7 @@ class Args:
     subject_pattern: re.Pattern | None
     output: OutputFormat
     output_file: Path | None
+    quiet: bool
 
 
 def _resolve_enabled(args, config, parser):
@@ -662,7 +667,7 @@ def _parse_checks(parser, value):
         parser.error(str(e))
 
 
-def _parse_args():  # noqa: PLR0915 Too many statements (59 > 50)
+def _parse_args():  # noqa: PLR0915 Too many statements (60 > 50)
     checks_list = ",".join(sorted(Check))
     parser = ArgumentParser(description="conventional commit checker")
     parser.add_argument("rev", nargs="?", default=None)
@@ -761,6 +766,13 @@ def _parse_args():  # noqa: PLR0915 Too many statements (59 > 50)
         metavar="FILE",
         help="write JSONL results to FILE (text still goes to stdout)",
     )
+    parser.add_argument(
+        "-q",
+        "--quiet",
+        action="store_true",
+        default=False,
+        help="suppress output for commits without errors or warnings",
+    )
     args = parser.parse_args()
     config = _load_config()
     enabled = _resolve_enabled(args, config, parser)
@@ -823,6 +835,7 @@ def _parse_args():  # noqa: PLR0915 Too many statements (59 > 50)
         subject_pattern=subject_pattern,
         output=OutputFormat(args.output),
         output_file=args.output_file,
+        quiet=args.quiet,
     )
 
 
@@ -838,7 +851,9 @@ def _jsonl_record(result, sha, subject):
     }
 
 
-def _report_jsonl(result, sha, subject):
+def _report_jsonl(result, sha, subject, *, quiet=False):
+    if quiet and not result.noteworthy:
+        return 0
     print(json.dumps(_jsonl_record(result, sha, subject)))
     return 0 if result.ok else 1
 
@@ -847,7 +862,9 @@ def _write_jsonl_record(result, sha, subject, file):
     file.write(json.dumps(_jsonl_record(result, sha, subject)) + "\n")
 
 
-def _report_text(result):
+def _report_text(result, *, quiet=False):
+    if quiet and not result.noteworthy:
+        return 0
     color = sys.stdout.isatty()
     for check, level, msg in result.errors:
         prefix = f"[{check}] " if check else ""
@@ -892,6 +909,14 @@ def _run_checks(args, rev, message, result):
         check_signature(rev, result)
 
 
+def _report_commit(args, result, sha, subject):
+    if args.output == OutputFormat.JSONL:
+        return _report_jsonl(result, sha, subject, quiet=args.quiet)
+    if args.rev_range and (not args.quiet or result.noteworthy):
+        print(f"{sha[:7]} {subject}")
+    return _report_text(result, quiet=args.quiet)
+
+
 def main():
     args = _parse_args()
 
@@ -911,13 +936,8 @@ def main():
                 subject = message.split("\n")[0]
                 result = Result()
                 _run_checks(args, rev, message, result)
-                if args.output == OutputFormat.JSONL:
-                    if _report_jsonl(result, rev, subject) != 0:
-                        failed = True
-                else:
-                    print(f"{rev[:7]} {subject}")
-                    if _report_text(result) != 0:
-                        failed = True
+                if _report_commit(args, result, rev, subject) != 0:
+                    failed = True
                 if out_file:
                     _write_jsonl_record(result, rev, subject, out_file)
             return 1 if failed else 0
@@ -927,6 +947,4 @@ def main():
         _run_checks(args, args.rev, args.message, result)
         if out_file:
             _write_jsonl_record(result, args.rev, subject, out_file)
-        if args.output == OutputFormat.JSONL:
-            return _report_jsonl(result, args.rev, subject)
-        return _report_text(result)
+        return _report_commit(args, result, args.rev, subject)

{git_commit_guard-0.22.2.dist-info → git_commit_guard-0.23.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-guard
-Version: 0.22.2
+Version: 0.23.0
 Summary: Opinionated conventional commit message linter with imperative mood detection
 Project-URL: Homepage, https://github.com/benner/commit-guard
 Project-URL: Repository, https://github.com/benner/commit-guard
@@ -36,7 +36,7 @@ Opinionated conventional commit message linter with imperative mood detection.
   verb, verified via nltk POS tagging — not a hand-coded regex of "bad"
   words.
 * **Signature verification without a local keyring.** Resolves the commit
-  author via the GitHub API and verifies GPG/SSH against their published
+  committer via the GitHub API and verifies GPG/SSH against their published
   `.gpg`/`.keys` — no per-runner key management.
 * **Strict by default.** Subject format, body, trailers, `Signed-off-by`,
   and signature all enforced out of the box; opt out with `--disable`.
@@ -242,7 +242,7 @@ independently of `--enable`/`--disable`.
 The `signature` check verifies the commit without any local keyring setup:
 
 1. If the repo has a GitHub remote, call the Commits API
-   (`GET /repos/{owner}/{repo}/commits/{sha}`) to resolve the author's GitHub
+   (`GET /repos/{owner}/{repo}/commits/{sha}`) to resolve the committer's GitHub
    username — this works for corporate emails, noreply addresses, or any email
    not listed publicly on a GitHub profile.
 2. If the Commits API is unavailable (no GitHub remote, commit not yet pushed,
@@ -250,7 +250,7 @@ The `signature` check verifies the commit without any local keyring setup:
    (`{id}+{username}@users.noreply.github.com` or
    `{username}@users.noreply.github.com`) — no API call needed.
 3. If neither of the above resolves a username, fall back to searching GitHub
-   by the commit author's email.
+   by the commit committer's email.
 4. Fetch the resolved user's public keys from `github.com/{username}.gpg`
    (GPG) and the `/users/{username}/ssh_signing_keys` API (SSH keys tagged
    with the **Signing key** role). Auth-only SSH keys are deliberately not
@@ -261,7 +261,7 @@ The `signature` check verifies the commit without any local keyring setup:
    `git verify-commit` with the SSH allowed-signers config.
 7. If any key verifies, the check passes. If none do, it fails.
 
-If the author cannot be resolved via either method, or the GitHub API is
+If the committer cannot be resolved via either method, or the GitHub API is
 unreachable, the check fails with a clear error.
 
 For private repositories, set `GITHUB_TOKEN` or `GH_TOKEN` so the Commits API
@@ -316,7 +316,7 @@ COMMIT_GUARD_GIT_TIMEOUT=30 commit-guard --range origin/main..HEAD
 In GitHub Actions, set it at the step or job level:
 
 ```yaml
-- uses: benner/commit-guard@v0.22.2
+- uses: benner/commit-guard@v0.23.0
   env:
     COMMIT_GUARD_GIT_TIMEOUT: 30
   with:
@@ -352,6 +352,22 @@ misconfigured range specs in CI. Use `--allow-empty` to exit 0 instead:
 commit-guard --range origin/main..HEAD --allow-empty
 ```
 
+### Quiet mode
+
+Use `--quiet` (or `-q`) to suppress output for commits that have nothing to
+report — only commits with errors or warnings are printed. On a long range
+this leaves exactly the offending commits in the output; a fully compliant
+range prints nothing and exits 0:
+
+```bash
+commit-guard --range origin/main..HEAD --quiet
+```
+
+Quiet mode applies to single-commit and range mode, in both text and
+`--output jsonl` formats. Exit codes are unchanged, so it composes with CI
+gating. `--output-file` is not affected — the file always receives the
+complete record stream.
+
 ### Machine-readable output
 
 Use `--output jsonl` to emit one JSON line per commit to stdout instead of the
@@ -400,7 +416,7 @@ steps:
   - uses: actions/checkout@v4
     with:
       fetch-depth: 0
-  - uses: benner/commit-guard@v0.22.2
+  - uses: benner/commit-guard@v0.23.0
 ```
 
 Check all commits in a pull request:
@@ -416,7 +432,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: benner/commit-guard@v0.22.2
+      - uses: benner/commit-guard@v0.23.0
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
 ```
@@ -424,7 +440,7 @@ jobs:
 Check a specific commit SHA (mirrors the positional CLI argument):
 
 ```yaml
-      - uses: benner/commit-guard@v0.22.2
+      - uses: benner/commit-guard@v0.23.0
         with:
           rev: ${{ github.sha }}
 ```
@@ -442,7 +458,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: benner/commit-guard@v0.22.2
+      - uses: benner/commit-guard@v0.23.0
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
           disable: signed-off,signature
@@ -462,7 +478,7 @@ jobs:
 When `output-file` is set the action exposes the path as an output:
 
 ```yaml
-      - uses: benner/commit-guard@v0.22.2
+      - uses: benner/commit-guard@v0.23.0
         id: cg
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
@@ -478,7 +494,7 @@ Add to your `.pre-commit-config.yaml`:
 ---
 repos:
   - repo: https://github.com/benner/commit-guard
-    rev: v0.22.2
+    rev: v0.23.0
     hooks:
       - id: commit-guard
       - id: commit-guard-signature

git_commit_guard-0.23.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+git_commit_guard/__init__.py,sha256=wiXXUQPw2NWPgWUh83EREtjp26L62X7fPNFZ0GcPbfQ,30139
+git_commit_guard-0.23.0.dist-info/METADATA,sha256=pGircQocHHj1TqurmthduMAdh4ovzZza9r056hlF6iY,16043
+git_commit_guard-0.23.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+git_commit_guard-0.23.0.dist-info/entry_points.txt,sha256=24HK4TwCgn3tSQHOWnGE6zJK6nvg7EMAut7VHe9nuH4,55
+git_commit_guard-0.23.0.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
+git_commit_guard-0.23.0.dist-info/RECORD,,

{git_commit_guard-0.22.2.dist-info → git_commit_guard-0.23.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.30.1
+Generator: hatchling 1.31.0
 Root-Is-Purelib: true
 Tag: py3-none-any

git_commit_guard-0.22.2.dist-info/RECORD

@@ -1,6 +0,0 @@
-git_commit_guard/__init__.py,sha256=FrKpmqyW_YO2RgMj8Ff2m1TVEqQqBDhvm1pFtfem8rQ,29599
-git_commit_guard-0.22.2.dist-info/METADATA,sha256=4pWaUYZ4ta6OwftzPFenE_KtBxzrFlmKcl1tKVi9qdE,15450
-git_commit_guard-0.22.2.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
-git_commit_guard-0.22.2.dist-info/entry_points.txt,sha256=24HK4TwCgn3tSQHOWnGE6zJK6nvg7EMAut7VHe9nuH4,55
-git_commit_guard-0.22.2.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
-git_commit_guard-0.22.2.dist-info/RECORD,,