git-commit-guard 0.15.1__tar.gz → 0.16.0__tar.gz

{git_commit_guard-0.15.1 → git_commit_guard-0.16.0}/.github/workflows/lint-commits.yml

@@ -22,7 +22,7 @@ jobs:
           key: nltk-averaged-perceptron-tagger-punkt
       - name: Lint commits
         # yamllint disable-line rule:line-length
-        uses: benner/commit-guard@c3ca496e477d64051d06fdb3aac44d8ffec7e852  # v0.14.1
+        uses: benner/commit-guard@064132b8b0cf5ec26083de7193f4e78d37a615d4  # v0.15.1
         with:
           range: origin/${{ github.base_ref }}..HEAD
           disable: signature

{git_commit_guard-0.15.1 → git_commit_guard-0.16.0}/.github/workflows/test.yml

@@ -4,6 +4,7 @@ on:  # yamllint disable-line rule:truthy
   pull_request:
 permissions:
   contents: read
+  pull-requests: write
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -24,4 +25,11 @@ jobs:
       - name: Run tests with coverage
         run: |-
           uv run --dev pytest \
-            tests/ --cov=git_commit_guard --cov-report=term-missing
+            tests/ --cov=git_commit_guard --cov-report=term-missing \
+            --cov-report=xml
+      - name: Post coverage comment
+        # yamllint disable-line rule:line-length
+        uses: MishaKav/pytest-coverage-comment@dd5b80bde6d16941f336518e92929e89069d8451  # v1.7.2
+        with:
+          pytest-xml-coverage-path: coverage.xml
+          unique-id-for-comment: coverage

{git_commit_guard-0.15.1 → git_commit_guard-0.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-guard
-Version: 0.15.1
+Version: 0.16.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
@@ -96,7 +96,7 @@ Available checks:
 * `subject` - Format matches `type(scope): description`, valid type,
     lowercase start, no trailing period, max 72 chars
 * `imperative` - First word is an imperative verb (for example `add` not `added`)
-* `body` - Body is present after a blank line
+* `body` - Blank line separates subject from body, and body is non-empty
 * `signed-off` - `Signed-off-by:` trailer exists
 * `signature` - Verify GPG or SSH signature
 
@@ -207,7 +207,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.15.0
+- uses: benner/commit-guard@v0.16.0
   env:
     COMMIT_GUARD_GIT_TIMEOUT: 30
   with:
@@ -280,6 +280,10 @@ commit-guard --range origin/main..HEAD --output-file results.jsonl
 `--output-file` is independent of `--output`: combining both writes JSONL to
 both stdout and the file.
 
+In GitHub Actions, `output-file` is the recommended way to get machine-readable
+results — text stays in the CI log and the file is accessible to subsequent steps
+via `steps.<id>.outputs.output-file`.
+
 ### GitHub Actions
 
 ```yaml
@@ -287,7 +291,7 @@ steps:
   - uses: actions/checkout@v4
     with:
       fetch-depth: 0
-  - uses: benner/commit-guard@v0.15.0
+  - uses: benner/commit-guard@v0.16.0
 ```
 
 Check all commits in a pull request:
@@ -303,11 +307,19 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: benner/commit-guard@v0.15.0
+      - uses: benner/commit-guard@v0.16.0
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
 ```
 
+Check a specific commit SHA (mirrors the positional CLI argument):
+
+```yaml
+      - uses: benner/commit-guard@v0.16.0
+        with:
+          rev: ${{ github.sha }}
+```
+
 All inputs are optional and mirror the CLI flags:
 
 ```yaml
@@ -321,7 +333,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: benner/commit-guard@v0.15.0
+      - uses: benner/commit-guard@v0.16.0
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
           disable: signed-off,signature
@@ -330,13 +342,15 @@ jobs:
           require-trailer: 'Closes,Reviewed-by'
           max-subject-length: '100'
           min-description-length: '10'
+          allow-empty: 'true'
+          include-merges: 'true'
           output-file: results.jsonl
 ```
 
 When `output-file` is set the action exposes the path as an output:
 
 ```yaml
-      - uses: benner/commit-guard@v0.15.0
+      - uses: benner/commit-guard@v0.16.0
         id: cg
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
@@ -352,7 +366,7 @@ Add to your `.pre-commit-config.yaml`:
 ---
 repos:
   - repo: https://github.com/benner/commit-guard
-    rev: v0.15.0
+    rev: v0.16.0
     hooks:
       - id: commit-guard
       - id: commit-guard-signature

{git_commit_guard-0.15.1 → git_commit_guard-0.16.0}/README.md

@@ -75,7 +75,7 @@ Available checks:
 * `subject` - Format matches `type(scope): description`, valid type,
     lowercase start, no trailing period, max 72 chars
 * `imperative` - First word is an imperative verb (for example `add` not `added`)
-* `body` - Body is present after a blank line
+* `body` - Blank line separates subject from body, and body is non-empty
 * `signed-off` - `Signed-off-by:` trailer exists
 * `signature` - Verify GPG or SSH signature
 
@@ -186,7 +186,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.15.0
+- uses: benner/commit-guard@v0.16.0
   env:
     COMMIT_GUARD_GIT_TIMEOUT: 30
   with:
@@ -259,6 +259,10 @@ commit-guard --range origin/main..HEAD --output-file results.jsonl
 `--output-file` is independent of `--output`: combining both writes JSONL to
 both stdout and the file.
 
+In GitHub Actions, `output-file` is the recommended way to get machine-readable
+results — text stays in the CI log and the file is accessible to subsequent steps
+via `steps.<id>.outputs.output-file`.
+
 ### GitHub Actions
 
 ```yaml
@@ -266,7 +270,7 @@ steps:
   - uses: actions/checkout@v4
     with:
       fetch-depth: 0
-  - uses: benner/commit-guard@v0.15.0
+  - uses: benner/commit-guard@v0.16.0
 ```
 
 Check all commits in a pull request:
@@ -282,11 +286,19 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: benner/commit-guard@v0.15.0
+      - uses: benner/commit-guard@v0.16.0
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
 ```
 
+Check a specific commit SHA (mirrors the positional CLI argument):
+
+```yaml
+      - uses: benner/commit-guard@v0.16.0
+        with:
+          rev: ${{ github.sha }}
+```
+
 All inputs are optional and mirror the CLI flags:
 
 ```yaml
@@ -300,7 +312,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: benner/commit-guard@v0.15.0
+      - uses: benner/commit-guard@v0.16.0
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
           disable: signed-off,signature
@@ -309,13 +321,15 @@ jobs:
           require-trailer: 'Closes,Reviewed-by'
           max-subject-length: '100'
           min-description-length: '10'
+          allow-empty: 'true'
+          include-merges: 'true'
           output-file: results.jsonl
 ```
 
 When `output-file` is set the action exposes the path as an output:
 
 ```yaml
-      - uses: benner/commit-guard@v0.15.0
+      - uses: benner/commit-guard@v0.16.0
         id: cg
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
@@ -331,7 +345,7 @@ Add to your `.pre-commit-config.yaml`:
 ---
 repos:
   - repo: https://github.com/benner/commit-guard
-    rev: v0.15.0
+    rev: v0.16.0
     hooks:
       - id: commit-guard
       - id: commit-guard-signature

{git_commit_guard-0.15.1 → git_commit_guard-0.16.0}/docs/index.html

@@ -332,7 +332,10 @@ $ commit-guard abc1234
 $ commit-guard --range origin/main..HEAD
 
 # read from a file (for git hooks)
-$ commit-guard --message-file .git/COMMIT_EDITMSG</code></pre>
+$ commit-guard --message-file .git/COMMIT_EDITMSG
+
+# pipe message via stdin
+$ echo "fix(auth): add token refresh" | commit-guard</code></pre>
 
         <h3>Checks</h3>
         <p>
@@ -351,8 +354,11 @@ $ commit-guard --message-file .git/COMMIT_EDITMSG</code></pre>
               <tr>
                 <td><code>subject</code></td>
                 <td>
-                  Format matches <code>type(scope): description</code>, valid
-                  type, lowercase start, no trailing period, max 72 chars
+                  <a href="https://www.conventionalcommits.org/" target="_blank" rel="noopener">Conventional Commits</a>
+                  format: valid type, lowercase start, no trailing period,
+                  max length (default 72). All limits are configurable. Use
+                  <code>!</code> before the colon for breaking changes:
+                  <code>feat!: remove endpoint</code>
                 </td>
               </tr>
               <tr>
@@ -363,7 +369,7 @@ $ commit-guard --message-file .git/COMMIT_EDITMSG</code></pre>
               </tr>
               <tr>
                 <td><code>body</code></td>
-                <td>Body is present after a blank line</td>
+                <td>Blank line separates subject from body, and body is non-empty</td>
               </tr>
               <tr>
                 <td><code>signed-off</code></td>
@@ -381,8 +387,9 @@ $ commit-guard --message-file .git/COMMIT_EDITMSG</code></pre>
       <section id="configuration">
         <h2>Configuration <a href="#configuration" class="anchor">#</a></h2>
         <p>
-          Place <code>.commit-guard.toml</code> in your project root. CLI flags
-          always take precedence over the config file.
+          Place <code>.commit-guard.toml</code> in your project root or any
+          parent directory — commit-guard searches upward and uses the first
+          file found. CLI flags always take precedence.
         </p>
         <pre><code class="language-toml"># .commit-guard.toml
 disable = ["signature", "body"]
@@ -392,6 +399,69 @@ types = ["feat", "fix", "chore", "wip"]
 max-subject-length = 100
 min-description-length = 10
 require-trailers = ["Closes", "Reviewed-by"]</code></pre>
+
+        <h3>Required trailers</h3>
+        <p>
+          Require arbitrary trailers in the commit message. Accepts a
+          comma-separated list; matching is case-sensitive and requires a
+          non-empty value after the colon (e.g. <code>Closes: #42</code>):
+        </p>
+        <pre><code class="language-bash">commit-guard --require-trailer "Closes,Reviewed-by"</code></pre>
+
+        <h3>Range options</h3>
+        <p>
+          When using <code>--range</code>, merge commits are excluded by
+          default. Use <code>--include-merges</code> to check them. An empty
+          range exits non-zero by default — use <code>--allow-empty</code> to
+          exit 0 instead:
+        </p>
+        <pre><code class="language-bash">commit-guard --range origin/main..HEAD --include-merges --allow-empty</code></pre>
+
+        <h3>Environment variables</h3>
+        <figure>
+          <table>
+            <thead>
+              <tr>
+                <th>Variable</th>
+                <th>Default</th>
+                <th>Description</th>
+              </tr>
+            </thead>
+            <tbody>
+              <tr>
+                <td><code>COMMIT_GUARD_GIT_TIMEOUT</code></td>
+                <td><code>10</code></td>
+                <td>Timeout in seconds for git subprocess calls</td>
+              </tr>
+            </tbody>
+          </table>
+        </figure>
+      </section>
+
+      <section id="output">
+        <h2>Output <a href="#output" class="anchor">#</a></h2>
+        <p>
+          Use <code>--output jsonl</code> to emit one JSON line per commit to
+          stdout instead of the default human-readable text:
+        </p>
+        <pre><code class="language-bash">commit-guard --range origin/main..HEAD --output jsonl | jq 'select(.ok == false)'</code></pre>
+        <p>Each line is a JSON object:</p>
+        <pre><code>{
+  "sha": "abc1234...",
+  "subject": "feat: add thing",
+  "ok": false,
+  "results": [{"check": "body", "level": "error", "message": "missing body"}]
+}</code></pre>
+        <p>
+          <code>sha</code> is <code>null</code> when reading from a file or
+          stdin. <code>results</code> is empty when all checks pass.
+        </p>
+        <p>
+          Use <code>--output-file FILE</code> to write JSONL to a file while
+          keeping human-readable text on stdout — useful in CI where you want
+          readable logs and structured results for downstream steps:
+        </p>
+        <pre><code class="language-bash">commit-guard --range origin/main..HEAD --output-file results.jsonl</code></pre>
       </section>
 
       <section id="github-actions">
@@ -407,18 +477,35 @@ require-trailers = ["Closes", "Reviewed-by"]</code></pre>
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: benner/commit-guard@v0.14.1
+      - uses: benner/commit-guard@v0.16.0
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
           disable: signed-off,signature</code></pre>
 
+        <p>Check a specific commit SHA:</p>
+        <pre><code class="language-yaml">      - uses: benner/commit-guard@v0.16.0
+        with:
+          rev: ${{ github.sha }}</code></pre>
+
+        <p>
+          All inputs mirror the CLI flags: <code>rev</code>,
+          <code>range</code>, <code>enable</code>, <code>disable</code>,
+          <code>scopes</code>, <code>require-scope</code>, <code>types</code>,
+          <code>max-subject-length</code>, <code>min-description-length</code>,
+          <code>require-trailer</code>, <code>allow-empty</code>,
+          <code>include-merges</code>, <code>output-file</code>.
+        </p>
+
         <p>
-          All inputs mirror the CLI flags: <code>enable</code>,
-          <code>disable</code>, <code>scopes</code>, <code>require-scope</code>,
-          <code>types</code>, <code>max-subject-length</code>,
-          <code>min-description-length</code>, <code>require-trailer</code>,
-          <code>output-file</code>.
+          When <code>output-file</code> is set the action exposes the path as
+          a step output, making JSONL results available to subsequent steps:
         </p>
+        <pre><code class="language-yaml">      - uses: benner/commit-guard@v0.16.0
+        id: cg
+        with:
+          range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
+          output-file: results.jsonl
+      - run: jq 'select(.ok == false)' "${{ steps.cg.outputs.output-file }}"</code></pre>
       </section>
 
       <section id="pre-commit">
@@ -426,7 +513,7 @@ require-trailers = ["Closes", "Reviewed-by"]</code></pre>
         <p>Add to <code>.pre-commit-config.yaml</code>:</p>
         <pre><code class="language-yaml">repos:
   - repo: https://github.com/benner/commit-guard
-    rev: v0.14.1
+    rev: v0.16.0
     hooks:
       - id: commit-guard
       - id: commit-guard-signature</code></pre>
@@ -596,7 +683,7 @@ require-trailers = ["Closes", "Reviewed-by"]</code></pre>
       });
 
       document.querySelectorAll(
-        "#configuration pre code, #github-actions pre code, #pre-commit pre code"
+        "#configuration pre code, #output pre code, #github-actions pre code, #pre-commit pre code"
       ).forEach((code) => {
         const text = code.innerText.trim();
         const isConfig = code.className.includes("language-");

{git_commit_guard-0.15.1 → git_commit_guard-0.16.0}/src/git_commit_guard/__init__.py

@@ -220,11 +220,15 @@ def check_imperative(desc, result):
 
 
 def check_body(lines, result):
-    if len(lines) < 3:  # noqa: PLR2004
+    if len(lines) == 1:
         result.error("missing body", check=Check.BODY)
         return
     if lines[1].strip():
         result.error("missing blank line between subject and body", check=Check.BODY)
+        return
+    if len(lines) == 2:  # noqa: PLR2004 Magic value used in comparison, consider replacing 2 with a constant variable
+        result.error("missing body", check=Check.BODY)
+        return
     body_lines = [ln for ln in lines[2:] if not _TRAILER_RE.match(ln)]
     if not any(ln.strip() for ln in body_lines):
         result.error("missing body", check=Check.BODY)

{git_commit_guard-0.15.1 → git_commit_guard-0.16.0}/tests/test_git_commit_guard.py

@@ -237,6 +237,12 @@ class TestCheckBody:
         check_body(["fix: add thing", "body text", "more"], r)
         assert not r.ok
 
+    def test_missing_blank_line_two_lines(self):
+        r = Result()
+        check_body(["fix: add thing", "body text"], r)
+        assert not r.ok
+        assert any("blank line" in msg for _, _, msg in r.errors)
+
     def test_blank_body_content(self):
         r = Result()
         check_body(["fix: add thing", "", "   "], r)