git-commit-guard 0.11.0__tar.gz → 0.13.0__tar.gz

{git_commit_guard-0.11.0 → git_commit_guard-0.13.0}/.github/workflows/lint-commits.yml

@@ -7,8 +7,6 @@ permissions:
 jobs:
   lint-commits:
     runs-on: ubuntu-latest
-    permissions:
-      contents: write
     steps:
       - name: Checkout code
         # yamllint disable-line rule:line-length
@@ -16,29 +14,15 @@ jobs:
         with:
           persist-credentials: false
           fetch-depth: 0
-      - name: Install Python
-        # yamllint disable-line rule:line-length
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v6.2.0
-        with:
-          python-version: '3.12'
-      - name: Install uv
-        # yamllint disable-line rule:line-length
-        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78  # v7.6.0
-      - name: Install commit-guard
-        run: uv pip install --system .
       - name: Cache NLTK data
+        # yamllint disable-line rule:line-length
         uses: actions/cache@668228422ae6a00e4ad889ee87cd7109ec5666a7  # v5.0.4
         with:
           path: ~/nltk_data
           key: nltk-averaged-perceptron-tagger-punkt
       - name: Lint commits
-        env:
-          BASE_REF: ${{ github.base_ref }}
-        run: |-
-          commits=$(git log --no-merges --format="%H" "origin/$BASE_REF"..HEAD)
-          failed=0
-          for sha in $commits; do
-            echo "--- checking $sha ---"
-            commit-guard --disable signature "$sha" || failed=1
-          done
-          exit $failed
+        # yamllint disable-line rule:line-length
+        uses: benner/commit-guard@cad366366cd6d2691f7c36ff5e7a9999279906dd  # v0.12.0
+        with:
+          range: origin/${{ github.base_ref }}..HEAD
+          disable: signature

{git_commit_guard-0.11.0 → git_commit_guard-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-guard
-Version: 0.11.0
+Version: 0.13.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
@@ -147,12 +147,33 @@ commit-guard --require-scope
 commit-guard --scopes auth,api --require-scope
 ```
 
+### Required custom trailers
+
+Require arbitrary trailers to be present in the commit message. Multiple
+trailers can be specified as a comma-separated list:
+
+```bash
+commit-guard --require-trailer Closes
+commit-guard --require-trailer "Closes,Reviewed-by"
+```
+
+In `.commit-guard.toml`:
+
+```toml
+require-trailers = ["Closes", "Reviewed-by"]
+```
+
+Trailer matching is case-sensitive and requires at least one non-space
+character after the colon (e.g. `Closes: #42`). This check runs
+independently of `--enable`/`--disable`.
+
 ### Configuration file
 
 Place `.commit-guard.toml` in your project root (or any parent directory) to
 set defaults for `enable`, `disable`, `scopes`, `require-scope`, `types`,
-`max-subject-length`, and `min-description-length`. commit-guard searches
-upward from the working directory and uses the first file found.
+`max-subject-length`, `min-description-length`, and `require-trailers`.
+commit-guard searches upward from the working directory and uses the first
+file found.
 
 ```toml
 # .commit-guard.toml
@@ -162,6 +183,7 @@ require-scope = true
 types = ["feat", "fix", "chore", "wip"]
 max-subject-length = 100
 min-description-length = 10
+require-trailers = ["Closes", "Reviewed-by"]
 ```
 
 ```toml
@@ -170,8 +192,8 @@ enable = ["subject", "imperative"]
 ```
 
 CLI flags (`--enable`, `--disable`, `--scopes`, `--require-scope`, `--types`,
-`--max-subject-length`, `--min-description-length`) take full precedence and
-ignore config file values when provided.
+`--max-subject-length`, `--min-description-length`, `--require-trailer`) take
+full precedence and ignore config file values when provided.
 
 ### Checking a range of commits
 
@@ -202,6 +224,58 @@ misconfigured range specs in CI. Use `--allow-empty` to exit 0 instead:
 commit-guard --range origin/main..HEAD --allow-empty
 ```
 
+### GitHub Actions
+
+```yaml
+steps:
+  - uses: actions/checkout@v4
+    with:
+      fetch-depth: 0
+  - uses: benner/commit-guard@v0.13.0
+```
+
+Check all commits in a pull request:
+
+```yaml
+jobs:
+  lint-commits:
+    runs-on: ubuntu-latest
+    env:
+      PR_BASE: ${{ github.event.pull_request.base.sha }}
+      PR_HEAD: ${{ github.event.pull_request.head.sha }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: benner/commit-guard@v0.13.0
+        with:
+          range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
+```
+
+All inputs are optional and mirror the CLI flags:
+
+```yaml
+jobs:
+  lint-commits:
+    runs-on: ubuntu-latest
+    env:
+      PR_BASE: ${{ github.event.pull_request.base.sha }}
+      PR_HEAD: ${{ github.event.pull_request.head.sha }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: benner/commit-guard@v0.13.0
+        with:
+          range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
+          disable: signed-off,signature
+          scopes: auth,api,db
+          require-scope: 'true'
+          require-trailer: 'Closes,Reviewed-by'
+          max-subject-length: '100'
+          min-description-length: '10'
+```
+
 ### pre-commit
 
 Add to your `.pre-commit-config.yaml`:
@@ -210,7 +284,7 @@ Add to your `.pre-commit-config.yaml`:
 ---
 repos:
   - repo: https://github.com/benner/commit-guard
-    rev: v0.1.0
+    rev: v0.13.0
     hooks:
       - id: commit-guard
       - id: commit-guard-signature

{git_commit_guard-0.11.0 → git_commit_guard-0.13.0}/README.md

@@ -126,12 +126,33 @@ commit-guard --require-scope
 commit-guard --scopes auth,api --require-scope
 ```
 
+### Required custom trailers
+
+Require arbitrary trailers to be present in the commit message. Multiple
+trailers can be specified as a comma-separated list:
+
+```bash
+commit-guard --require-trailer Closes
+commit-guard --require-trailer "Closes,Reviewed-by"
+```
+
+In `.commit-guard.toml`:
+
+```toml
+require-trailers = ["Closes", "Reviewed-by"]
+```
+
+Trailer matching is case-sensitive and requires at least one non-space
+character after the colon (e.g. `Closes: #42`). This check runs
+independently of `--enable`/`--disable`.
+
 ### Configuration file
 
 Place `.commit-guard.toml` in your project root (or any parent directory) to
 set defaults for `enable`, `disable`, `scopes`, `require-scope`, `types`,
-`max-subject-length`, and `min-description-length`. commit-guard searches
-upward from the working directory and uses the first file found.
+`max-subject-length`, `min-description-length`, and `require-trailers`.
+commit-guard searches upward from the working directory and uses the first
+file found.
 
 ```toml
 # .commit-guard.toml
@@ -141,6 +162,7 @@ require-scope = true
 types = ["feat", "fix", "chore", "wip"]
 max-subject-length = 100
 min-description-length = 10
+require-trailers = ["Closes", "Reviewed-by"]
 ```
 
 ```toml
@@ -149,8 +171,8 @@ enable = ["subject", "imperative"]
 ```
 
 CLI flags (`--enable`, `--disable`, `--scopes`, `--require-scope`, `--types`,
-`--max-subject-length`, `--min-description-length`) take full precedence and
-ignore config file values when provided.
+`--max-subject-length`, `--min-description-length`, `--require-trailer`) take
+full precedence and ignore config file values when provided.
 
 ### Checking a range of commits
 
@@ -181,6 +203,58 @@ misconfigured range specs in CI. Use `--allow-empty` to exit 0 instead:
 commit-guard --range origin/main..HEAD --allow-empty
 ```
 
+### GitHub Actions
+
+```yaml
+steps:
+  - uses: actions/checkout@v4
+    with:
+      fetch-depth: 0
+  - uses: benner/commit-guard@v0.13.0
+```
+
+Check all commits in a pull request:
+
+```yaml
+jobs:
+  lint-commits:
+    runs-on: ubuntu-latest
+    env:
+      PR_BASE: ${{ github.event.pull_request.base.sha }}
+      PR_HEAD: ${{ github.event.pull_request.head.sha }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: benner/commit-guard@v0.13.0
+        with:
+          range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
+```
+
+All inputs are optional and mirror the CLI flags:
+
+```yaml
+jobs:
+  lint-commits:
+    runs-on: ubuntu-latest
+    env:
+      PR_BASE: ${{ github.event.pull_request.base.sha }}
+      PR_HEAD: ${{ github.event.pull_request.head.sha }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: benner/commit-guard@v0.13.0
+        with:
+          range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
+          disable: signed-off,signature
+          scopes: auth,api,db
+          require-scope: 'true'
+          require-trailer: 'Closes,Reviewed-by'
+          max-subject-length: '100'
+          min-description-length: '10'
+```
+
 ### pre-commit
 
 Add to your `.pre-commit-config.yaml`:
@@ -189,7 +263,7 @@ Add to your `.pre-commit-config.yaml`:
 ---
 repos:
   - repo: https://github.com/benner/commit-guard
-    rev: v0.1.0
+    rev: v0.13.0
     hooks:
       - id: commit-guard
       - id: commit-guard-signature

git_commit_guard-0.13.0/action.yml

@@ -0,0 +1,85 @@
+---
+name: commit-guard
+description: Conventional commit message linter with imperative mood detection
+author: Nerijus Bendžiūnas
+branding:
+  icon: shield
+  color: green
+inputs:
+  rev:
+    description: Commit SHA to check (defaults to HEAD)
+    required: false
+  range:
+    description: Revision range to check (e.g. abc123..HEAD)
+    required: false
+  enable:
+    description: Comma-separated checks to enable
+    required: false
+  disable:
+    description: Comma-separated checks to disable
+    required: false
+  scopes:
+    description: Comma-separated list of allowed scopes
+    required: false
+  require-scope:
+    description: Require a scope in the subject line
+    required: false
+    default: 'false'
+  types:
+    description: Comma-separated list of allowed types (replaces defaults)
+    required: false
+  max-subject-length:
+    description: Maximum subject line length (default 72)
+    required: false
+  min-description-length:
+    description: Minimum description length in characters (default 0, off)
+    required: false
+  allow-empty:
+    description: Exit 0 when --range yields no commits
+    required: false
+    default: 'false'
+  include-merges:
+    description: Include merge commits when checking a range
+    required: false
+    default: 'false'
+runs:
+  using: composite
+  steps:
+    - name: Set up uv
+      # yamllint disable-line rule:line-length
+      uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78  # v7.6.0
+      with:
+        enable-cache: false
+    - name: Install commit-guard
+      run: uv tool install git-commit-guard
+      shell: bash
+    - name: Run commit-guard
+      env:
+        CG_REV: ${{ inputs.rev }}
+        CG_RANGE: ${{ inputs.range }}
+        CG_ENABLE: ${{ inputs.enable }}
+        CG_DISABLE: ${{ inputs.disable }}
+        CG_SCOPES: ${{ inputs.scopes }}
+        CG_REQUIRE_SCOPE: ${{ inputs.require-scope }}
+        CG_TYPES: ${{ inputs.types }}
+        CG_MAX_SUBJECT_LENGTH: ${{ inputs.max-subject-length }}
+        CG_MIN_DESCRIPTION_LENGTH: ${{ inputs.min-description-length }}
+        CG_ALLOW_EMPTY: ${{ inputs.allow-empty }}
+        CG_INCLUDE_MERGES: ${{ inputs.include-merges }}
+      run: |
+        ARGS=()
+        [[ -n "$CG_REV" ]] && ARGS+=("$CG_REV")
+        [[ -n "$CG_RANGE" ]] && ARGS+=(--range "$CG_RANGE")
+        [[ -n "$CG_ENABLE" ]] && ARGS+=(--enable "$CG_ENABLE")
+        [[ -n "$CG_DISABLE" ]] && ARGS+=(--disable "$CG_DISABLE")
+        [[ -n "$CG_SCOPES" ]] && ARGS+=(--scopes "$CG_SCOPES")
+        [[ "$CG_REQUIRE_SCOPE" == "true" ]] && ARGS+=(--require-scope)
+        [[ -n "$CG_TYPES" ]] && ARGS+=(--types "$CG_TYPES")
+        [[ -n "$CG_MAX_SUBJECT_LENGTH" ]] && \
+            ARGS+=(--max-subject-length "$CG_MAX_SUBJECT_LENGTH")
+        [[ -n "$CG_MIN_DESCRIPTION_LENGTH" ]] && \
+            ARGS+=(--min-description-length "$CG_MIN_DESCRIPTION_LENGTH")
+        [[ "$CG_ALLOW_EMPTY" == "true" ]] && ARGS+=(--allow-empty)
+        [[ "$CG_INCLUDE_MERGES" == "true" ]] && ARGS+=(--include-merges)
+        commit-guard "${ARGS[@]}"
+      shell: bash

{git_commit_guard-0.11.0 → git_commit_guard-0.13.0}/src/git_commit_guard/__init__.py

@@ -157,6 +157,7 @@ def check_subject(  # noqa: PLR0913 Too many arguments in function definition (7
 
 
 def check_imperative(desc, result):
+    _ensure_nltk_data()
     tokens = nltk.word_tokenize(desc.lower())
     if not tokens:
         return
@@ -195,6 +196,13 @@ def check_signed_off(message, result):
         result.error("missing 'Signed-off-by' trailer")
 
 
+def check_required_trailers(message, required, result):
+    for trailer in required:
+        pattern = re.compile(rf"^{re.escape(trailer)}:\s+\S", re.MULTILINE)
+        if not pattern.search(message):
+            result.error(f"missing required trailer: {trailer}")
+
+
 def check_signature(rev, result):
     proc = subprocess.run(  # noqa: S603
         ["git", "verify-commit", rev],  # noqa: S607
@@ -257,6 +265,7 @@ class Args:
     rev_range: str | None
     allow_empty: bool
     include_merges: bool
+    required_trailers: list
 
 
 def _resolve_enabled(args, config, parser):
@@ -291,6 +300,14 @@ def _resolve_min_description_length(args, config):
     return 0
 
 
+def _resolve_required_trailers(args, config):
+    if args.require_trailer:
+        return [t.strip() for t in args.require_trailer.split(",")]
+    if config.get("require-trailers"):
+        return list(config["require-trailers"])
+    return []
+
+
 def _resolve_types(args, config):
     if args.types:
         return frozenset(t.strip() for t in args.types.split(","))
@@ -381,6 +398,11 @@ def _parse_args():
         default=False,
         help="exit 0 when --range yields no commits (default: exit 1)",
     )
+    parser.add_argument(
+        "--require-trailer",
+        metavar="TRAILER[,TRAILER,...]",
+        help="require these trailers in the commit message",
+    )
     parser.add_argument(
         "--include-merges",
         action="store_true",
@@ -394,6 +416,7 @@ def _parse_args():
     allowed_types = _resolve_types(args, config)
     max_subject_length = _resolve_max_subject_length(args, config)
     min_description_length = _resolve_min_description_length(args, config)
+    required_trailers = _resolve_required_trailers(args, config)
 
     if args.allow_empty and not args.rev_range:
         parser.error("--allow-empty requires --range")
@@ -430,6 +453,7 @@ def _parse_args():
         rev_range=args.rev_range,
         allow_empty=args.allow_empty,
         include_merges=args.include_merges,
+        required_trailers=required_trailers,
     )
 
 
@@ -466,6 +490,8 @@ def _run_checks(args, rev, message, result):
         check_body(lines, result)
     if Check.SIGNED_OFF in args.enabled:
         check_signed_off(message, result)
+    if args.required_trailers:
+        check_required_trailers(message, args.required_trailers, result)
     if Check.SIGNATURE in args.enabled and rev:
         check_signature(rev, result)
 
@@ -473,9 +499,6 @@ def _run_checks(args, rev, message, 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:

{git_commit_guard-0.11.0 → git_commit_guard-0.13.0}/tests/test_git_commit_guard.py

@@ -18,10 +18,12 @@ from git_commit_guard import (
     _report,
     _resolve_max_subject_length,
     _resolve_min_description_length,
+    _resolve_required_trailers,
     _resolve_types,
     _strip_comments,
     check_body,
     check_imperative,
+    check_required_trailers,
     check_signature,
     check_signed_off,
     check_subject,
@@ -273,6 +275,83 @@ class TestCheckSignedOff:
         assert not r.ok
 
 
+class TestCheckRequiredTrailers:
+    def test_present_passes(self):
+        r = Result()
+        check_required_trailers("fix: add x\n\nbody\n\nCloses: #42", ["Closes"], r)
+        assert r.ok
+
+    def test_missing_fails(self):
+        r = Result()
+        check_required_trailers("fix: add x\n\nbody", ["Closes"], r)
+        assert not r.ok
+        assert "missing required trailer: Closes" in r.errors[0][1]
+
+    def test_multiple_all_present_passes(self):
+        r = Result()
+        check_required_trailers(
+            "fix: add x\n\nbody\n\nCloses: #42\nReviewed-by: Jane",
+            ["Closes", "Reviewed-by"],
+            r,
+        )
+        assert r.ok
+
+    def test_multiple_one_missing_fails(self):
+        r = Result()
+        check_required_trailers(
+            "fix: add x\n\nbody\n\nCloses: #42",
+            ["Closes", "Reviewed-by"],
+            r,
+        )
+        assert not r.ok
+        assert any("Reviewed-by" in msg for _, msg in r.errors)
+
+    def test_case_sensitive(self):
+        r = Result()
+        check_required_trailers("fix: add x\n\nbody\n\ncloses: #42", ["Closes"], r)
+        assert not r.ok
+
+    def test_empty_required_list_always_passes(self):
+        r = Result()
+        check_required_trailers("fix: add x", [], r)
+        assert r.ok
+
+
+class TestResolveRequiredTrailers:
+    def test_defaults_to_empty(self):
+        assert _resolve_required_trailers(Namespace(require_trailer=None), {}) == []
+
+    def test_cli_flag_single(self):
+        result = _resolve_required_trailers(Namespace(require_trailer="Closes"), {})
+        assert result == ["Closes"]
+
+    def test_cli_flag_multiple(self):
+        result = _resolve_required_trailers(
+            Namespace(require_trailer="Closes,Reviewed-by"), {}
+        )
+        assert result == ["Closes", "Reviewed-by"]
+
+    def test_cli_flag_strips_spaces(self):
+        result = _resolve_required_trailers(
+            Namespace(require_trailer="Closes, Reviewed-by"), {}
+        )
+        assert result == ["Closes", "Reviewed-by"]
+
+    def test_config(self):
+        result = _resolve_required_trailers(
+            Namespace(require_trailer=None),
+            {"require-trailers": ["Closes", "Reviewed-by"]},
+        )
+        assert result == ["Closes", "Reviewed-by"]
+
+    def test_cli_overrides_config(self):
+        result = _resolve_required_trailers(
+            Namespace(require_trailer="Fixes"),
+            {"require-trailers": ["Closes"]},
+        )
+        assert result == ["Fixes"]
+
+
 class TestCheckImperative:
     def test_imperative_verb_passes(self):
         r = Result()
@@ -1103,3 +1182,89 @@ class TestGetRangeRevs:
             pytest.raises(SystemExit, match="git error"),
         ):
             _get_range_revs("bogus")
+
+
+class TestRequireTrailerIntegration:
+    def test_require_trailer_flag_passes(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text(
+            "fix: add thing\n\nbody\n\nCloses: #42\nSigned-off-by: A <a@b.com>"
+        )
+        argv = [
+            "cg",
+            "--message-file",
+            str(f),
+            "--disable",
+            "signature,imperative",
+            "--require-trailer",
+            "Closes",
+        ]
+        with patch("sys.argv", argv):
+            assert main() == 0
+
+    def test_require_trailer_flag_fails(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text("fix: add thing\n\nbody\n\nSigned-off-by: A <a@b.com>")
+        argv = [
+            "cg",
+            "--message-file",
+            str(f),
+            "--disable",
+            "signature,imperative",
+            "--require-trailer",
+            "Closes",
+        ]
+        with patch("sys.argv", argv):
+            assert main() == 1
+
+    def test_require_trailer_multiple_passes(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text(
+            "fix: add thing\n\nbody\n\n"
+            "Closes: #42\nReviewed-by: Jane\nSigned-off-by: A <a@b.com>"
+        )
+        argv = [
+            "cg",
+            "--message-file",
+            str(f),
+            "--disable",
+            "signature,imperative",
+            "--require-trailer",
+            "Closes,Reviewed-by",
+        ]
+        with patch("sys.argv", argv):
+            assert main() == 0
+
+    def test_require_trailer_from_config(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text("fix: add thing\n\nbody\n\nSigned-off-by: A <a@b.com>")
+        argv = ["cg", "--message-file", str(f), "--disable", "signature,imperative"]
+        with (
+            patch("sys.argv", argv),
+            patch(
+                "git_commit_guard._load_config",
+                return_value={"require-trailers": ["Closes"]},
+            ),
+        ):
+            assert main() == 1
+
+    def test_require_trailer_cli_overrides_config(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text("fix: add thing\n\nbody\n\nFixes: #99\nSigned-off-by: A <a@b.com>")
+        argv = [
+            "cg",
+            "--message-file",
+            str(f),
+            "--disable",
+            "signature,imperative",
+            "--require-trailer",
+            "Fixes",
+        ]
+        with (
+            patch("sys.argv", argv),
+            patch(
+                "git_commit_guard._load_config",
+                return_value={"require-trailers": ["Closes"]},
+            ),
+        ):
+            assert main() == 0