git-commit-guard 0.14.0__tar.gz → 0.15.0__tar.gz

git_commit_guard-0.15.0/.editorconfig

@@ -0,0 +1,23 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.py]
+indent_style = space
+indent_size = 4
+max_line_length = 88
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+[*.toml]
+indent_style = space
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false

{git_commit_guard-0.14.0 → git_commit_guard-0.15.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@0f2660f0b4d0ea25b8524acfb459a35e544252cb  # v0.13.0
+        uses: benner/commit-guard@c3ca496e477d64051d06fdb3aac44d8ffec7e852  # v0.14.1
         with:
           range: origin/${{ github.base_ref }}..HEAD
           disable: signature

git_commit_guard-0.15.0/.markdownlint.json

@@ -0,0 +1,5 @@
+{
+    "MD013": {
+        "tables": false
+    }
+}

{git_commit_guard-0.14.0 → git_commit_guard-0.15.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-guard
-Version: 0.14.0
+Version: 0.15.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
@@ -31,10 +31,9 @@ imperative verb.
 
 ```bash
 $ commit-guard
-✗ subject does not match 'type(scope): description':
-  Merge pull request #5 from fix/branch
-✗ missing 'Signed-off-by' trailer
-✗ commit is not signed (GPG/SSH)
+  ✗ [subject] subject does not match 'type(scope): description': WIP
+  ✗ [signed-off] missing 'Signed-off-by' trailer
+  ✗ [signature] commit is not signed (GPG/SSH)
 ```
 
 ## Installation
@@ -195,6 +194,26 @@ CLI flags (`--enable`, `--disable`, `--scopes`, `--require-scope`, `--types`,
 `--max-subject-length`, `--min-description-length`, `--require-trailer`) take
 full precedence and ignore config file values when provided.
 
+### Environment variables
+
+| Variable                   | Default | Description                                  |
+| -------------------------- | ------- | -------------------------------------------- |
+| `COMMIT_GUARD_GIT_TIMEOUT` | `10`    | Timeout in seconds for git subprocess calls. |
+
+```bash
+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
+  env:
+    COMMIT_GUARD_GIT_TIMEOUT: 30
+  with:
+    range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
+```
+
 ### Checking a range of commits
 
 Use `--range` to check all commits in a revision range. All commits are
@@ -227,7 +246,7 @@ commit-guard --range origin/main..HEAD --allow-empty
 ### Machine-readable output
 
 Use `--output jsonl` to emit one JSON line per commit to stdout instead of the
-default human-readable text on stderr:
+default human-readable text:
 
 ```bash
 commit-guard --range origin/main..HEAD --output jsonl
@@ -251,6 +270,16 @@ checks pass. Pipe to `jq` for filtering:
 commit-guard --range origin/main..HEAD --output jsonl | jq 'select(.ok == false)'
 ```
 
+Use `--output-file FILE` to write JSONL to a file while keeping human-readable
+text on stdout:
+
+```bash
+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.
+
 ### GitHub Actions
 
 ```yaml
@@ -258,7 +287,7 @@ steps:
   - uses: actions/checkout@v4
     with:
       fetch-depth: 0
-  - uses: benner/commit-guard@v0.14.0
+  - uses: benner/commit-guard@v0.15.0
 ```
 
 Check all commits in a pull request:
@@ -274,7 +303,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: benner/commit-guard@v0.14.0
+      - uses: benner/commit-guard@v0.15.0
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
 ```
@@ -292,7 +321,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: benner/commit-guard@v0.14.0
+      - uses: benner/commit-guard@v0.15.0
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
           disable: signed-off,signature
@@ -301,6 +330,18 @@ jobs:
           require-trailer: 'Closes,Reviewed-by'
           max-subject-length: '100'
           min-description-length: '10'
+          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
+        id: cg
+        with:
+          range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
+          output-file: results.jsonl
+      - run: jq 'select(.ok == false)' "${{ steps.cg.outputs.output-file }}"
 ```
 
 ### pre-commit
@@ -311,7 +352,7 @@ Add to your `.pre-commit-config.yaml`:
 ---
 repos:
   - repo: https://github.com/benner/commit-guard
-    rev: v0.14.0
+    rev: v0.15.0
     hooks:
       - id: commit-guard
       - id: commit-guard-signature

{git_commit_guard-0.14.0 → git_commit_guard-0.15.0}/README.md

@@ -10,10 +10,9 @@ imperative verb.
 
 ```bash
 $ commit-guard
-✗ subject does not match 'type(scope): description':
-  Merge pull request #5 from fix/branch
-✗ missing 'Signed-off-by' trailer
-✗ commit is not signed (GPG/SSH)
+  ✗ [subject] subject does not match 'type(scope): description': WIP
+  ✗ [signed-off] missing 'Signed-off-by' trailer
+  ✗ [signature] commit is not signed (GPG/SSH)
 ```
 
 ## Installation
@@ -174,6 +173,26 @@ CLI flags (`--enable`, `--disable`, `--scopes`, `--require-scope`, `--types`,
 `--max-subject-length`, `--min-description-length`, `--require-trailer`) take
 full precedence and ignore config file values when provided.
 
+### Environment variables
+
+| Variable                   | Default | Description                                  |
+| -------------------------- | ------- | -------------------------------------------- |
+| `COMMIT_GUARD_GIT_TIMEOUT` | `10`    | Timeout in seconds for git subprocess calls. |
+
+```bash
+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
+  env:
+    COMMIT_GUARD_GIT_TIMEOUT: 30
+  with:
+    range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
+```
+
 ### Checking a range of commits
 
 Use `--range` to check all commits in a revision range. All commits are
@@ -206,7 +225,7 @@ commit-guard --range origin/main..HEAD --allow-empty
 ### Machine-readable output
 
 Use `--output jsonl` to emit one JSON line per commit to stdout instead of the
-default human-readable text on stderr:
+default human-readable text:
 
 ```bash
 commit-guard --range origin/main..HEAD --output jsonl
@@ -230,6 +249,16 @@ checks pass. Pipe to `jq` for filtering:
 commit-guard --range origin/main..HEAD --output jsonl | jq 'select(.ok == false)'
 ```
 
+Use `--output-file FILE` to write JSONL to a file while keeping human-readable
+text on stdout:
+
+```bash
+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.
+
 ### GitHub Actions
 
 ```yaml
@@ -237,7 +266,7 @@ steps:
   - uses: actions/checkout@v4
     with:
       fetch-depth: 0
-  - uses: benner/commit-guard@v0.14.0
+  - uses: benner/commit-guard@v0.15.0
 ```
 
 Check all commits in a pull request:
@@ -253,7 +282,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: benner/commit-guard@v0.14.0
+      - uses: benner/commit-guard@v0.15.0
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
 ```
@@ -271,7 +300,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: benner/commit-guard@v0.14.0
+      - uses: benner/commit-guard@v0.15.0
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
           disable: signed-off,signature
@@ -280,6 +309,18 @@ jobs:
           require-trailer: 'Closes,Reviewed-by'
           max-subject-length: '100'
           min-description-length: '10'
+          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
+        id: cg
+        with:
+          range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
+          output-file: results.jsonl
+      - run: jq 'select(.ok == false)' "${{ steps.cg.outputs.output-file }}"
 ```
 
 ### pre-commit
@@ -290,7 +331,7 @@ Add to your `.pre-commit-config.yaml`:
 ---
 repos:
   - repo: https://github.com/benner/commit-guard
-    rev: v0.14.0
+    rev: v0.15.0
     hooks:
       - id: commit-guard
       - id: commit-guard-signature

{git_commit_guard-0.14.0 → git_commit_guard-0.15.0}/action.yml

@@ -42,6 +42,16 @@ inputs:
     description: Include merge commits when checking a range
     required: false
     default: 'false'
+  require-trailer:
+    description: Comma-separated list of required trailers (e.g. Closes,Reviewed-by)
+    required: false
+  output-file:
+    description: Write JSONL results to this file path (text still goes to stdout)
+    required: false
+outputs:
+  output-file:
+    description: Path to the JSONL output file (set only when output-file input is provided)
+    value: ${{ steps.run.outputs.output-file }}
 runs:
   using: composite
   steps:
@@ -54,6 +64,7 @@ runs:
       run: uv tool install git-commit-guard
       shell: bash
     - name: Run commit-guard
+      id: run
       env:
         CG_REV: ${{ inputs.rev }}
         CG_RANGE: ${{ inputs.range }}
@@ -66,6 +77,8 @@ runs:
         CG_MIN_DESCRIPTION_LENGTH: ${{ inputs.min-description-length }}
         CG_ALLOW_EMPTY: ${{ inputs.allow-empty }}
         CG_INCLUDE_MERGES: ${{ inputs.include-merges }}
+        CG_REQUIRE_TRAILER: ${{ inputs.require-trailer }}
+        CG_OUTPUT_FILE: ${{ inputs.output-file }}
       run: |
         ARGS=()
         [[ -n "$CG_REV" ]] && ARGS+=("$CG_REV")
@@ -81,5 +94,8 @@ runs:
             ARGS+=(--min-description-length "$CG_MIN_DESCRIPTION_LENGTH")
         [[ "$CG_ALLOW_EMPTY" == "true" ]] && ARGS+=(--allow-empty)
         [[ "$CG_INCLUDE_MERGES" == "true" ]] && ARGS+=(--include-merges)
+        [[ -n "$CG_REQUIRE_TRAILER" ]] && ARGS+=(--require-trailer "$CG_REQUIRE_TRAILER")
+        [[ -n "$CG_OUTPUT_FILE" ]] && ARGS+=(--output-file "$CG_OUTPUT_FILE")
         commit-guard "${ARGS[@]}"
+        [[ -n "$CG_OUTPUT_FILE" ]] && echo "output-file=$CG_OUTPUT_FILE" >> "$GITHUB_OUTPUT"
       shell: bash

git_commit_guard-0.15.0/docs/commit-guard-icon.svg

@@ -0,0 +1,49 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="512" height="512" viewBox="0 0 512 512">
+  <defs>
+    <linearGradient id="shield_bg" x1="0%" y1="0%" x2="0%" y2="100%">
+      <stop offset="0%" style="stop-color:#357ab8;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#1c3d61;stop-opacity:1" />
+    </linearGradient>
+    
+    <linearGradient id="shield_bevel" x1="0%" y1="0%" x2="0%" y2="100%">
+      <stop offset="0%" style="stop-color:#2a5f94;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#10283f;stop-opacity:1" />
+    </linearGradient>
+    
+    <radialGradient id="central_glow" cx="50%" cy="50%" r="50%">
+      <stop offset="0%" style="stop-color:#4ac34a;stop-opacity:0.3" />
+      <stop offset="100%" style="stop-color:#1c3d61;stop-opacity:0" />
+    </radialGradient>
+
+    <path id="shield_shape" d="M 256,16 C 180,64 120,72 32,72 L 32,256 C 32,400 120,464 256,496 C 392,464 480,400 480,256 L 480,72 C 392,72 332,64 256,16 Z" />
+    
+    <mask id="shield_halfs_mask">
+      <use href="#shield_shape" fill="white"/>
+      <rect x="256" y="0" width="256" height="512" fill="black"/>
+    </mask>
+  </defs>
+
+  <g style="filter:drop-shadow(0px 8px 10px rgba(0,0,0,0.3))">
+    <use href="#shield_shape" fill="url(#shield_bevel)" />
+
+    <path d="M 256,40 C 188,80 134,88 56,88 L 56,256 C 56,384 134,440 256,468 C 378,440 456,384 456,256 L 456,88 C 378,88 324,80 256,40 Z" fill="url(#shield_bg)" />
+
+    <path d="M 256,40 C 188,80 134,88 56,88 L 56,256 C 56,384 134,440 256,468 L 256,40 Z" fill="#152e4a" opacity="0.4" />
+
+    <path d="M 256,40 C 188,80 134,88 56,88 L 56,256 C 56,384 134,440 256,468 C 378,440 456,384 456,256 L 456,88 C 378,88 324,80 256,40 Z" stroke="#3d8bd1" stroke-width="6" fill="none" opacity="0.6"/>
+
+    <g transform="translate(256, 260)">
+      <circle r="140" fill="url(#central_glow)" opacity="0.7" />
+      
+      <g transform="translate(0, 15)">
+        <path d="M -90,-45 L 0,0 L 0,90 M 90,-45 L 0,0" stroke="#f0f0f0" stroke-width="12" stroke-linecap="round" stroke-linejoin="round" fill="none" />
+        <circle cx="-90" cy="-45" r="22" fill="#4ac34a" stroke="#f0f0f0" stroke-width="6" />
+        <circle cx="90" cy="-45" r="22" fill="#4ac34a" stroke="#f0f0f0" stroke-width="6" />
+        <circle cx="0" cy="0" r="22" fill="#4ac34a" stroke="#f0f0f0" stroke-width="6" />
+        <circle cx="0" cy="90" r="22" fill="#4ac34a" stroke="#f0f0f0" stroke-width="6" />
+      </g>
+      
+      <path d="M -50,-120 L -10,-80 L 70,-160" stroke="#f0f0f0" stroke-width="20" stroke-linecap="round" stroke-linejoin="round" fill="none" transform="translate(0, 15)" />
+    </g>
+  </g>
+</svg>