git-commit-guard 0.9.0__tar.gz → 0.10.0__tar.gz

git_commit_guard-0.10.0/.github/workflows/release.yml

@@ -0,0 +1,33 @@
+---
+name: Release
+on:  # yamllint disable-line rule:truthy
+  push:
+    tags:
+      - 'v*'
+permissions:
+  contents: write
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        # yamllint disable-line rule:line-length
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+      - name: Generate release notes
+        id: git-cliff
+        # yamllint disable-line rule:line-length
+        uses: orhun/git-cliff-action@c93ef52f3d0ddcdcc9bd5447d98d458a11cd4f72  # v4.7.1
+        with:
+          args: --current
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ github.ref_name }}
+          NOTES_FILE: ${{ steps.git-cliff.outputs.changelog }}
+        run: |-
+          gh release create "$TAG" \
+            --title "$TAG" \
+            --notes-file "$NOTES_FILE"

{git_commit_guard-0.9.0 → git_commit_guard-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-guard
-Version: 0.9.0
+Version: 0.10.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
@@ -167,16 +167,31 @@ provided.
 
 ### Checking a range of commits
 
+Use `--range` to check all commits in a revision range. All commits are
+checked and a single non-zero exit code is returned if any fail:
+
+```bash
+# check all commits in a PR
+commit-guard --range origin/main..HEAD
+
+# check between two tags
+commit-guard --range v1.0..v2.0
+
+# only subject checks on a range
+commit-guard --range origin/main..HEAD --enable subject,imperative
+```
+
+Merge commits are excluded by default. Use `--include-merges` to check them:
+
+```bash
+commit-guard --range origin/main..HEAD --include-merges
+```
+
+An empty range (no commits) exits non-zero by default — this catches
+misconfigured range specs in CI. Use `--allow-empty` to exit 0 instead:
+
 ```bash
-# all non-merge commits between tags
-git rev-list --no-merges v1.0..v2.0 | while read -r rev; do
-    commit-guard "$rev" || git log -1 --oneline "$rev"
-done
-
-# only subject checks on a PR range
-git rev-list --no-merges origin/main..HEAD | while read -r rev; do
-    commit-guard "$rev" --enable subject,imperative
-done
+commit-guard --range origin/main..HEAD --allow-empty
 ```
 
 ### pre-commit

{git_commit_guard-0.9.0 → git_commit_guard-0.10.0}/README.md

@@ -146,16 +146,31 @@ provided.
 
 ### Checking a range of commits
 
+Use `--range` to check all commits in a revision range. All commits are
+checked and a single non-zero exit code is returned if any fail:
+
+```bash
+# check all commits in a PR
+commit-guard --range origin/main..HEAD
+
+# check between two tags
+commit-guard --range v1.0..v2.0
+
+# only subject checks on a range
+commit-guard --range origin/main..HEAD --enable subject,imperative
+```
+
+Merge commits are excluded by default. Use `--include-merges` to check them:
+
+```bash
+commit-guard --range origin/main..HEAD --include-merges
+```
+
+An empty range (no commits) exits non-zero by default — this catches
+misconfigured range specs in CI. Use `--allow-empty` to exit 0 instead:
+
 ```bash
-# all non-merge commits between tags
-git rev-list --no-merges v1.0..v2.0 | while read -r rev; do
-    commit-guard "$rev" || git log -1 --oneline "$rev"
-done
-
-# only subject checks on a PR range
-git rev-list --no-merges origin/main..HEAD | while read -r rev; do
-    commit-guard "$rev" --enable subject,imperative
-done
+commit-guard --range origin/main..HEAD --allow-empty
 ```
 
 ### pre-commit

{git_commit_guard-0.9.0 → git_commit_guard-0.10.0}/src/git_commit_guard/__init__.py

@@ -224,6 +224,23 @@ def _get_message(rev):
         sys.exit(f"git error: {stderr}")
 
 
+def _get_range_revs(rev_range, *, include_merges=False):
+    cmd = ["git", "log", "--format=%H"]
+    if not include_merges:
+        cmd.append("--no-merges")
+    cmd.append(rev_range)
+    try:
+        output = subprocess.check_output(  # noqa: S603
+            cmd,
+            text=True,
+            stderr=subprocess.PIPE,
+            timeout=GIT_TIMEOUT,
+        ).strip()
+    except subprocess.CalledProcessError as e:
+        sys.exit(f"git error: {e.stderr.strip()}")
+    return output.split("\n") if output else []
+
+
 @dataclass
 class Args:
     rev: str | None
@@ -233,6 +250,9 @@ class Args:
     require_scope: bool
     allowed_types: frozenset
     max_subject_length: int
+    rev_range: str | None
+    allow_empty: bool
+    include_merges: bool
 
 
 def _resolve_enabled(args, config, parser):
@@ -330,6 +350,24 @@ def _parse_args():
         metavar="N",
         help=f"maximum subject line length (default: {MAX_SUBJECT_LEN})",
     )
+    parser.add_argument(
+        "--range",
+        dest="rev_range",
+        metavar="REF..REF",
+        help="check all commits in the given revision range",
+    )
+    parser.add_argument(
+        "--allow-empty",
+        action="store_true",
+        default=False,
+        help="exit 0 when --range yields no commits (default: exit 1)",
+    )
+    parser.add_argument(
+        "--include-merges",
+        action="store_true",
+        default=False,
+        help="include merge commits when checking a range (default: excluded)",
+    )
     args = parser.parse_args()
     config = _load_config()
     enabled = _resolve_enabled(args, config, parser)
@@ -337,7 +375,17 @@ def _parse_args():
     allowed_types = _resolve_types(args, config)
     max_subject_length = _resolve_max_subject_length(args, config)
 
-    if args.message_file:
+    if args.allow_empty and not args.rev_range:
+        parser.error("--allow-empty requires --range")
+    if args.include_merges and not args.rev_range:
+        parser.error("--include-merges requires --range")
+
+    if args.rev_range:
+        if args.rev is not None or args.message_file:
+            parser.error("--range cannot be combined with rev or --message-file")
+        rev = None
+        message = ""
+    elif args.message_file:
         rev = None
         message = _strip_comments(args.message_file.read_text().strip())
     elif args.rev:
@@ -358,6 +406,9 @@ def _parse_args():
         require_scope=require_scope,
         allowed_types=allowed_types,
         max_subject_length=max_subject_length,
+        rev_range=args.rev_range,
+        allow_empty=args.allow_empty,
+        include_merges=args.include_merges,
     )
 
 
@@ -371,15 +422,8 @@ def _report(result):
     return 0 if result.ok else 1
 
 
-def main():
-    args = _parse_args()
-    lines = args.message.split("\n")
-
-    if Check.IMPERATIVE in args.enabled:
-        _ensure_nltk_data()
-
-    result = Result()
-
+def _run_checks(args, rev, message, result):
+    lines = message.split("\n")
     desc = None
     if Check.SUBJECT in args.enabled:
         desc = check_subject(
@@ -399,8 +443,32 @@ def main():
     if Check.BODY in args.enabled:
         check_body(lines, result)
     if Check.SIGNED_OFF in args.enabled:
-        check_signed_off(args.message, result)
-    if Check.SIGNATURE in args.enabled and args.rev:
-        check_signature(args.rev, result)
+        check_signed_off(message, result)
+    if Check.SIGNATURE in args.enabled and rev:
+        check_signature(rev, result)
 
+
+def main():
+    args = _parse_args()
+
+    if Check.IMPERATIVE in args.enabled:
+        _ensure_nltk_data()
+
+    if args.rev_range:
+        revs = _get_range_revs(args.rev_range, include_merges=args.include_merges)
+        if not revs:
+            sys.stderr.write("no commits in range\n")
+            return 0 if args.allow_empty else 1
+        failed = False
+        for rev in revs:
+            message = _strip_comments(_get_message(rev))
+            sys.stderr.write(f"{rev[:7]} {message.split('\n')[0]}\n")
+            result = Result()
+            _run_checks(args, rev, message, result)
+            if _report(result) != 0:
+                failed = True
+        return 1 if failed else 0
+
+    result = Result()
+    _run_checks(args, args.rev, args.message, result)
     return _report(result)

{git_commit_guard-0.9.0 → git_commit_guard-0.10.0}/tests/test_git_commit_guard.py

@@ -11,6 +11,7 @@ from git_commit_guard import (
     _download_if_missing,
     _ensure_nltk_data,
     _get_message,
+    _get_range_revs,
     _load_config,
     _parse_checks,
     _parse_config_checks,
@@ -831,3 +832,167 @@ class TestMain:
             ),
         ):
             assert main() == 0
+
+    def test_range_all_pass(self):
+        with (
+            patch(
+                "sys.argv",
+                ["cg", "--range", "origin/main..HEAD", "--disable", "signature"],
+            ),
+            patch(
+                "git_commit_guard._get_range_revs",
+                return_value=["abc1234", "def5678"],
+            ),
+            patch("git_commit_guard._get_message", return_value=_VALID_MSG),
+        ):
+            assert main() == 0
+
+    def test_range_one_fails(self):
+        messages = {"abc1234": _VALID_MSG, "def5678": "not a valid commit message"}
+        with (
+            patch(
+                "sys.argv",
+                [
+                    "cg",
+                    "--range",
+                    "origin/main..HEAD",
+                    "--disable",
+                    "signature,body,signed-off,imperative",
+                ],
+            ),
+            patch(
+                "git_commit_guard._get_range_revs",
+                return_value=["abc1234", "def5678"],
+            ),
+            patch(
+                "git_commit_guard._get_message",
+                side_effect=lambda rev: messages[rev],
+            ),
+        ):
+            assert main() == 1
+
+    def test_range_all_fail_returns_one(self):
+        with (
+            patch(
+                "sys.argv",
+                [
+                    "cg",
+                    "--range",
+                    "origin/main..HEAD",
+                    "--disable",
+                    "signature,body,signed-off,imperative",
+                ],
+            ),
+            patch(
+                "git_commit_guard._get_range_revs",
+                return_value=["abc1234"],
+            ),
+            patch(
+                "git_commit_guard._get_message",
+                return_value="not a valid commit message",
+            ),
+        ):
+            assert main() == 1
+
+    def test_range_empty_returns_one(self, capsys):
+        with (
+            patch("sys.argv", ["cg", "--range", "origin/main..HEAD"]),
+            patch("git_commit_guard._get_range_revs", return_value=[]),
+        ):
+            assert main() == 1
+        assert "no commits in range" in capsys.readouterr().err
+
+    def test_range_empty_with_allow_empty_returns_zero(self, capsys):
+        with (
+            patch("sys.argv", ["cg", "--range", "origin/main..HEAD", "--allow-empty"]),
+            patch("git_commit_guard._get_range_revs", return_value=[]),
+        ):
+            assert main() == 0
+        assert "no commits in range" in capsys.readouterr().err
+
+    def test_allow_empty_without_range_exits(self):
+        with (
+            patch("sys.argv", ["cg", "--allow-empty"]),
+            pytest.raises(SystemExit),
+        ):
+            main()
+
+    def test_include_merges_without_range_exits(self):
+        with (
+            patch("sys.argv", ["cg", "--include-merges"]),
+            pytest.raises(SystemExit),
+        ):
+            main()
+
+    def test_range_include_merges_flag(self):
+        with (
+            patch(
+                "sys.argv",
+                [
+                    "cg",
+                    "--range",
+                    "origin/main..HEAD",
+                    "--include-merges",
+                    "--disable",
+                    "signature",
+                ],
+            ),
+            patch(
+                "git_commit_guard._get_range_revs",
+                return_value=["abc1234"],
+            ) as mock,
+            patch("git_commit_guard._get_message", return_value=_VALID_MSG),
+        ):
+            main()
+        mock.assert_called_once_with("origin/main..HEAD", include_merges=True)
+
+    def test_range_conflicts_with_rev(self):
+        with (
+            patch("sys.argv", ["cg", "abc123", "--range", "origin/main..HEAD"]),
+            pytest.raises(SystemExit),
+        ):
+            main()
+
+    def test_range_conflicts_with_message_file(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text(_VALID_MSG)
+        with (
+            patch(
+                "sys.argv",
+                ["cg", "--message-file", str(f), "--range", "origin/main..HEAD"],
+            ),
+            pytest.raises(SystemExit),
+        ):
+            main()
+
+
+class TestGetRangeRevs:
+    def test_returns_shas(self):
+        with patch(
+            "git_commit_guard.subprocess.check_output",
+            return_value="abc1234\ndef5678",
+        ):
+            assert _get_range_revs("origin/main..HEAD") == ["abc1234", "def5678"]
+
+    def test_excludes_merges_by_default(self):
+        with patch("git_commit_guard.subprocess.check_output", return_value="") as mock:
+            _get_range_revs("origin/main..HEAD")
+        assert "--no-merges" in mock.call_args[0][0]
+
+    def test_includes_merges_when_requested(self):
+        with patch("git_commit_guard.subprocess.check_output", return_value="") as mock:
+            _get_range_revs("origin/main..HEAD", include_merges=True)
+        assert "--no-merges" not in mock.call_args[0][0]
+
+    def test_empty_range_returns_empty_list(self):
+        with patch("git_commit_guard.subprocess.check_output", return_value=""):
+            assert _get_range_revs("origin/main..HEAD") == []
+
+    def test_invalid_range_exits(self):
+        err = subprocess.CalledProcessError(128, "git")
+        err.stderr = "fatal: bad revision 'bogus'"
+        with (
+            patch("git_commit_guard.subprocess.check_output", side_effect=err),
+            pytest.raises(SystemExit, match="git error"),
+        ):
+            _get_range_revs("bogus")

git_commit_guard-0.9.0/htmlcov/.gitignore

@@ -1,2 +0,0 @@
-# Created by coverage.py
-*

git_commit_guard-0.9.0/htmlcov/class_index.html

@@ -1,161 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-    <title>Coverage report</title>
-    <link rel="icon" sizes="32x32" href="favicon_32_cb_c827f16f.png">
-    <link rel="stylesheet" href="style_cb_9ff733b0.css" type="text/css">
-    <script src="coverage_html_cb_dd2e7eb5.js" defer></script>
-</head>
-<body class="indexfile">
-<header>
-    <div class="content">
-        <h1>Coverage report:
-            <span class="pc_cov">99%</span>
-        </h1>
-        <aside id="help_panel_wrapper">
-            <input id="help_panel_state" type="checkbox">
-            <label for="help_panel_state">
-                <img id="keyboard_icon" src="keybd_closed_cb_900cfef5.png" alt="Show/hide keyboard shortcuts">
-            </label>
-            <div id="help_panel">
-                <p class="legend">Shortcuts on this page</p>
-                <div class="keyhelp">
-                    <p>
-                        <kbd>f</kbd>
-                        <kbd>n</kbd>
-                        <kbd>s</kbd>
-                        <kbd>m</kbd>
-                        <kbd>x</kbd>
-                        <kbd>c</kbd>
-                        &nbsp; change column sorting
-                    </p>
-                    <p>
-                        <kbd>[</kbd>
-                        <kbd>]</kbd>
-                        &nbsp; prev/next file
-                    </p>
-                    <p>
-                        <kbd>?</kbd> &nbsp; show/hide this help
-                    </p>
-                </div>
-            </div>
-        </aside>
-        <form id="filter_container">
-            <input id="filter" type="text" value="" placeholder="filter...">
-            <div>
-                <input id="hide100" type="checkbox" >
-                <label for="hide100">hide covered</label>
-            </div>
-        </form>
-        <h2>
-                <a class="button" href="index.html">Files</a>
-                <a class="button" href="function_index.html">Functions</a>
-                <a class="button current">Classes</a>
-        </h2>
-        <p class="text">
-            <a class="nav" href="https://coverage.readthedocs.io/en/7.13.5">coverage.py v7.13.5</a>,
-            created at 2026-04-18 23:09 +0300
-        </p>
-    </div>
-</header>
-<main id="index">
-    <table class="index" data-sortable>
-        <thead>
-            <tr class="tablehead" title="Click to sort">
-                <th id="file" class="name" aria-sort="none" data-shortcut="f">File<span class="arrows"></span></th>
-                <th id="region" class="name" aria-sort="none" data-default-sort-order="ascending" data-shortcut="n">class<span class="arrows"></span></th>
-                <th class="spacer">&nbsp;</th>
-                <th id="statements" aria-sort="none" data-default-sort-order="descending" data-shortcut="s">statements<span class="arrows"></span></th>
-                <th id="missing" aria-sort="none" data-default-sort-order="descending" data-shortcut="m">missing<span class="arrows"></span></th>
-                <th id="excluded" aria-sort="none" data-default-sort-order="descending" data-shortcut="x">excluded<span class="arrows"></span></th>
-                <th class="spacer">&nbsp;</th>
-                <th id="coverage" aria-sort="none" data-shortcut="c">coverage<span class="arrows"></span></th>
-            </tr>
-        </thead>
-        <tbody>
-            <tr class="region">
-                <td class="name"><a href="z_262b75d81d1cf686___init___py.html#t44">src&#8201;/&#8201;git_commit_guard&#8201;/&#8201;__init__.py</a></td>
-                <td class="name"><a href="z_262b75d81d1cf686___init___py.html#t44"><data value='Check'>Check</data></a></td>
-                <td class="spacer">&nbsp;</td>
-                <td>0</td>
-                <td>0</td>
-                <td>0</td>
-                <td class="spacer">&nbsp;</td>
-                <td data-ratio="0 0">100%</td>
-            </tr>
-            <tr class="region">
-                <td class="name"><a href="z_262b75d81d1cf686___init___py.html#t72">src&#8201;/&#8201;git_commit_guard&#8201;/&#8201;__init__.py</a></td>
-                <td class="name"><a href="z_262b75d81d1cf686___init___py.html#t72"><data value='Level'>Level</data></a></td>
-                <td class="spacer">&nbsp;</td>
-                <td>0</td>
-                <td>0</td>
-                <td>0</td>
-                <td class="spacer">&nbsp;</td>
-                <td data-ratio="0 0">100%</td>
-            </tr>
-            <tr class="region">
-                <td class="name"><a href="z_262b75d81d1cf686___init___py.html#t86">src&#8201;/&#8201;git_commit_guard&#8201;/&#8201;__init__.py</a></td>
-                <td class="name"><a href="z_262b75d81d1cf686___init___py.html#t86"><data value='Result'>Result</data></a></td>
-                <td class="spacer">&nbsp;</td>
-                <td>4</td>
-                <td>0</td>
-                <td>0</td>
-                <td class="spacer">&nbsp;</td>
-                <td data-ratio="4 4">100%</td>
-            </tr>
-            <tr class="region">
-                <td class="name"><a href="z_262b75d81d1cf686___init___py.html#t218">src&#8201;/&#8201;git_commit_guard&#8201;/&#8201;__init__.py</a></td>
-                <td class="name"><a href="z_262b75d81d1cf686___init___py.html#t218"><data value='Args'>Args</data></a></td>
-                <td class="spacer">&nbsp;</td>
-                <td>0</td>
-                <td>0</td>
-                <td>0</td>
-                <td class="spacer">&nbsp;</td>
-                <td data-ratio="0 0">100%</td>
-            </tr>
-            <tr class="region">
-                <td class="name"><a href="z_262b75d81d1cf686___init___py.html">src&#8201;/&#8201;git_commit_guard&#8201;/&#8201;__init__.py</a></td>
-                <td class="name"><a href="z_262b75d81d1cf686___init___py.html"><data value=''><span class='no-noun'>(no class)</span></data></a></td>
-                <td class="spacer">&nbsp;</td>
-                <td>212</td>
-                <td>2</td>
-                <td>0</td>
-                <td class="spacer">&nbsp;</td>
-                <td data-ratio="210 212">99%</td>
-            </tr>
-        </tbody>
-        <tfoot>
-            <tr class="total">
-                <td class="name">Total</td>
-                <td class="name">&nbsp;</td>
-                <td class="spacer">&nbsp;</td>
-                <td>216</td>
-                <td>2</td>
-                <td>0</td>
-                <td class="spacer">&nbsp;</td>
-                <td data-ratio="214 216">99%</td>
-            </tr>
-        </tfoot>
-    </table>
-    <p id="no_rows">
-        No items found using the specified filter.
-    </p>
-</main>
-<footer>
-    <div class="content">
-        <p>
-            <a class="nav" href="https://coverage.readthedocs.io/en/7.13.5">coverage.py v7.13.5</a>,
-            created at 2026-04-18 23:09 +0300
-        </p>
-    </div>
-    <aside class="hidden">
-        <a id="prevFileLink" class="nav" href=""></a>
-        <a id="nextFileLink" class="nav" href=""></a>
-        <button type="button" class="button_prev_file" data-shortcut="["></button>
-        <button type="button" class="button_next_file" data-shortcut="]"></button>
-        <button type="button" class="button_show_hide_help" data-shortcut="?"></button>
-    </aside>
-</footer>
-</body>
-</html>