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

{git_commit_guard-0.10.0 → git_commit_guard-0.12.0}/.github/workflows/release.yml

@@ -6,6 +6,7 @@ on:  # yamllint disable-line rule:truthy
       - 'v*'
 permissions:
   contents: write
+  id-token: write
 jobs:
   release:
     runs-on: ubuntu-latest
@@ -16,6 +17,19 @@ jobs:
         with:
           persist-credentials: false
           fetch-depth: 0
+      - name: Set up Python
+        # yamllint disable-line rule:line-length
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v6.2.0
+      - name: Set up uv
+        # yamllint disable-line rule:line-length
+        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78  # v7.6.0
+        with:
+          enable-cache: false
+      - name: Build package
+        run: uv build
+      - name: Publish to PyPI
+        # yamllint disable-line rule:line-length
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b  # v1.14.0
       - name: Generate release notes
         id: git-cliff
         # yamllint disable-line rule:line-length
@@ -31,3 +45,8 @@ jobs:
           gh release create "$TAG" \
             --title "$TAG" \
             --notes-file "$NOTES_FILE"
+      - name: Upload dist to GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ github.ref_name }}
+        run: gh release upload "$TAG" dist/*

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-guard
-Version: 0.10.0
+Version: 0.12.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
@@ -110,6 +110,13 @@ The default maximum subject line length is 72 characters. Override with
 commit-guard --max-subject-length 100
 ```
 
+By default there is no minimum description length. Enforce one with
+`--min-description-length`:
+
+```bash
+commit-guard --min-description-length 10
+```
+
 ### Type validation
 
 By default the standard conventional commit types are accepted. Use `--types`
@@ -143,9 +150,9 @@ commit-guard --scopes auth,api --require-scope
 ### Configuration file
 
 Place `.commit-guard.toml` in your project root (or any parent directory) to
-set defaults for `enable`, `disable`, `scopes`, `require-scope`, `types`, and
-`max-subject-length`. commit-guard searches upward from the working directory
-and uses the first file found.
+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.
 
 ```toml
 # .commit-guard.toml
@@ -154,6 +161,7 @@ scopes = ["auth", "api", "db"]
 require-scope = true
 types = ["feat", "fix", "chore", "wip"]
 max-subject-length = 100
+min-description-length = 10
 ```
 
 ```toml
@@ -162,8 +170,8 @@ enable = ["subject", "imperative"]
 ```
 
 CLI flags (`--enable`, `--disable`, `--scopes`, `--require-scope`, `--types`,
-`--max-subject-length`) take full precedence and ignore config file values when
-provided.
+`--max-subject-length`, `--min-description-length`) take full precedence and
+ignore config file values when provided.
 
 ### Checking a range of commits
 
@@ -194,6 +202,57 @@ 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@vX.Y.Z
+```
+
+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@vX.Y.Z
+        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@vX.Y.Z
+        with:
+          range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
+          disable: signed-off,signature
+          scopes: auth,api,db
+          require-scope: 'true'
+          max-subject-length: '100'
+          min-description-length: '10'
+```
+
 ### pre-commit
 
 Add to your `.pre-commit-config.yaml`:

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

@@ -89,6 +89,13 @@ The default maximum subject line length is 72 characters. Override with
 commit-guard --max-subject-length 100
 ```
 
+By default there is no minimum description length. Enforce one with
+`--min-description-length`:
+
+```bash
+commit-guard --min-description-length 10
+```
+
 ### Type validation
 
 By default the standard conventional commit types are accepted. Use `--types`
@@ -122,9 +129,9 @@ commit-guard --scopes auth,api --require-scope
 ### Configuration file
 
 Place `.commit-guard.toml` in your project root (or any parent directory) to
-set defaults for `enable`, `disable`, `scopes`, `require-scope`, `types`, and
-`max-subject-length`. commit-guard searches upward from the working directory
-and uses the first file found.
+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.
 
 ```toml
 # .commit-guard.toml
@@ -133,6 +140,7 @@ scopes = ["auth", "api", "db"]
 require-scope = true
 types = ["feat", "fix", "chore", "wip"]
 max-subject-length = 100
+min-description-length = 10
 ```
 
 ```toml
@@ -141,8 +149,8 @@ enable = ["subject", "imperative"]
 ```
 
 CLI flags (`--enable`, `--disable`, `--scopes`, `--require-scope`, `--types`,
-`--max-subject-length`) take full precedence and ignore config file values when
-provided.
+`--max-subject-length`, `--min-description-length`) take full precedence and
+ignore config file values when provided.
 
 ### Checking a range of commits
 
@@ -173,6 +181,57 @@ 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@vX.Y.Z
+```
+
+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@vX.Y.Z
+        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@vX.Y.Z
+        with:
+          range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
+          disable: signed-off,signature
+          scopes: auth,api,db
+          require-scope: 'true'
+          max-subject-length: '100'
+          min-description-length: '10'
+```
+
 ### pre-commit
 
 Add to your `.pre-commit-config.yaml`:

git_commit_guard-0.12.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.10.0 → git_commit_guard-0.12.0}/src/git_commit_guard/__init__.py

@@ -120,12 +120,13 @@ def _strip_comments(message):
     )
 
 
-def check_subject(  # noqa: PLR0913 Too many arguments in function definition (6 > 5)
+def check_subject(  # noqa: PLR0913 Too many arguments in function definition (7 > 5)
     line,
     result,
     allowed_scopes=frozenset(),
     allowed_types=TYPES,
     max_subject_length=MAX_SUBJECT_LEN,
+    min_description_length=0,
     *,
     require_scope=False,
 ):
@@ -150,6 +151,8 @@ def check_subject(  # noqa: PLR0913 Too many arguments in function definition (6
         result.error("description must not end with period")
     if len(line) > max_subject_length:
         result.error(f"subject too long: {len(line)} > {max_subject_length}")
+    if min_description_length > 0 and len(desc) < min_description_length:
+        result.error(f"description too short: {len(desc)} < {min_description_length}")
     return desc
 
 
@@ -250,6 +253,7 @@ class Args:
     require_scope: bool
     allowed_types: frozenset
     max_subject_length: int
+    min_description_length: int
     rev_range: str | None
     allow_empty: bool
     include_merges: bool
@@ -279,6 +283,14 @@ def _resolve_max_subject_length(args, config):
     return MAX_SUBJECT_LEN
 
 
+def _resolve_min_description_length(args, config):
+    if args.min_description_length is not None:
+        return args.min_description_length
+    if "min-description-length" in config:
+        return config["min-description-length"]
+    return 0
+
+
 def _resolve_types(args, config):
     if args.types:
         return frozenset(t.strip() for t in args.types.split(","))
@@ -350,6 +362,13 @@ def _parse_args():
         metavar="N",
         help=f"maximum subject line length (default: {MAX_SUBJECT_LEN})",
     )
+    parser.add_argument(
+        "--min-description-length",
+        type=int,
+        default=None,
+        metavar="N",
+        help="minimum description length in characters (default: 0, off)",
+    )
     parser.add_argument(
         "--range",
         dest="rev_range",
@@ -374,6 +393,7 @@ def _parse_args():
     allowed_scopes, require_scope = _resolve_scopes(args, config)
     allowed_types = _resolve_types(args, config)
     max_subject_length = _resolve_max_subject_length(args, config)
+    min_description_length = _resolve_min_description_length(args, config)
 
     if args.allow_empty and not args.rev_range:
         parser.error("--allow-empty requires --range")
@@ -406,6 +426,7 @@ def _parse_args():
         require_scope=require_scope,
         allowed_types=allowed_types,
         max_subject_length=max_subject_length,
+        min_description_length=min_description_length,
         rev_range=args.rev_range,
         allow_empty=args.allow_empty,
         include_merges=args.include_merges,
@@ -432,6 +453,7 @@ def _run_checks(args, rev, message, result):
             args.allowed_scopes,
             args.allowed_types,
             args.max_subject_length,
+            args.min_description_length,
             require_scope=args.require_scope,
         )
     if Check.IMPERATIVE in args.enabled:

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

@@ -17,6 +17,7 @@ from git_commit_guard import (
     _parse_config_checks,
     _report,
     _resolve_max_subject_length,
+    _resolve_min_description_length,
     _resolve_types,
     _strip_comments,
     check_body,
@@ -161,6 +162,22 @@ class TestCheckSubject:
         check_subject("fix: ok", r, max_subject_length=10)
         assert r.ok
 
+    def test_min_description_length_zero_disables_check(self):
+        r = Result()
+        check_subject("fix: add x", r, min_description_length=0)
+        assert r.ok
+
+    def test_min_description_length_enforced(self):
+        r = Result()
+        check_subject("fix: add x", r, min_description_length=6)
+        assert not r.ok
+        assert any("description too short" in m for _, m in r.errors)
+
+    def test_min_description_length_exact_passes(self):
+        r = Result()
+        check_subject("fix: hello", r, min_description_length=5)
+        assert r.ok
+
     def test_custom_type_passes(self):
         r = Result()
         check_subject("wip: add thing", r, allowed_types=frozenset(["wip"]))
@@ -455,6 +472,32 @@ class TestResolveMaxSubjectLength:
         assert result == 50  # noqa: PLR2004 Magic value used in comparison, consider replacing 50 with a constant variable
 
 
+class TestResolveMinDescriptionLength:
+    def test_defaults_to_zero(self):
+        result = _resolve_min_description_length(
+            Namespace(min_description_length=None), {}
+        )
+        assert result == 0
+
+    def test_cli_flag_overrides_default(self):
+        result = _resolve_min_description_length(
+            Namespace(min_description_length=10), {}
+        )
+        assert result == 10  # noqa: PLR2004 Magic value used in comparison, consider replacing 10 with a constant variable
+
+    def test_config_overrides_default(self):
+        result = _resolve_min_description_length(
+            Namespace(min_description_length=None), {"min-description-length": 8}
+        )
+        assert result == 8  # noqa: PLR2004 Magic value used in comparison, consider replacing 8 with a constant variable
+
+    def test_cli_overrides_config(self):
+        result = _resolve_min_description_length(
+            Namespace(min_description_length=10), {"min-description-length": 8}
+        )
+        assert result == 10  # noqa: PLR2004 Magic value used in comparison, consider replacing 10 with a constant variable
+
+
 class TestResolveTypes:
     def test_defaults_when_no_config_or_flag(self):
         assert _resolve_types(Namespace(types=None), {}) == TYPES
@@ -812,6 +855,70 @@ class TestMain:
         ):
             assert main() == 0
 
+    def test_min_description_length_flag_passes(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text("fix: add thing\n\nbody\n\nSigned-off-by: A User <a@b.com>")
+        argv = [
+            "cg",
+            "--message-file",
+            str(f),
+            "--disable",
+            "signature",
+            "--min-description-length",
+            "5",
+        ]
+        with patch("sys.argv", argv):
+            assert main() == 0
+
+    def test_min_description_length_flag_fails(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text("fix: add x\n\nbody\n\nSigned-off-by: A User <a@b.com>")
+        argv = [
+            "cg",
+            "--message-file",
+            str(f),
+            "--disable",
+            "signature,imperative",
+            "--min-description-length",
+            "6",
+        ]
+        with patch("sys.argv", argv):
+            assert main() == 1
+
+    def test_min_description_length_from_config(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text("fix: add x\n\nbody\n\nSigned-off-by: A User <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={"min-description-length": 6},
+            ),
+        ):
+            assert main() == 1
+
+    def test_min_description_length_cli_overrides_config(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text("fix: add x\n\nbody\n\nSigned-off-by: A User <a@b.com>")
+        argv = [
+            "cg",
+            "--message-file",
+            str(f),
+            "--disable",
+            "signature,imperative",
+            "--min-description-length",
+            "3",
+        ]
+        with (
+            patch("sys.argv", argv),
+            patch(
+                "git_commit_guard._load_config",
+                return_value={"min-description-length": 6},
+            ),
+        ):
+            assert main() == 0
+
     def test_types_cli_overrides_config(self, tmp_path):
         f = tmp_path / "msg"
         f.write_text("wip: add thing\n\nbody\n\nSigned-off-by: A User <a@b.com>")