action.yml

---
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
  no-require-lowercase:
    description: Allow description to start with uppercase (default false)
    required: false
    default: 'false'
  no-trailing-chars:
    description: Forbidden trailing characters, comma-separated (default '.', '!',
      '?', ' ')
    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'
  require-subject-pattern:
    description: Regex the subject line must match (e.g. '[A-Z]+-[0-9]+')
    required: 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
  github-token:
    description: GitHub token for Commits API access (signature check). Defaults to
      the workflow's automatic token; override with a PAT for cross-repo lookups.
    required: false
    default: ${{ github.token }}
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:
    - 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
      id: run
      env:
        GITHUB_TOKEN: ${{ inputs.github-token }}
        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_NO_REQUIRE_LOWERCASE: ${{ inputs.no-require-lowercase }}
        CG_NO_TRAILING_CHARS: ${{ inputs.no-trailing-chars }}
        CG_ALLOW_EMPTY: ${{ inputs.allow-empty }}
        CG_INCLUDE_MERGES: ${{ inputs.include-merges }}
        CG_REQUIRE_SUBJECT_PATTERN: ${{ inputs.require-subject-pattern }}
        CG_REQUIRE_TRAILER: ${{ inputs.require-trailer }}
        CG_OUTPUT_FILE: ${{ inputs.output-file }}
      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_NO_REQUIRE_LOWERCASE" == "true" ]] && ARGS+=(--no-require-lowercase)
        [[ -n "$CG_NO_TRAILING_CHARS" ]] && ARGS+=(--no-trailing-chars "$CG_NO_TRAILING_CHARS")
        [[ "$CG_ALLOW_EMPTY" == "true" ]] && ARGS+=(--allow-empty)
        [[ "$CG_INCLUDE_MERGES" == "true" ]] && ARGS+=(--include-merges)
        [[ -n "$CG_REQUIRE_SUBJECT_PATTERN" ]] && \
            ARGS+=(--require-subject-pattern "$CG_REQUIRE_SUBJECT_PATTERN")
        [[ -n "$CG_REQUIRE_TRAILER" ]] && ARGS+=(--require-trailer "$CG_REQUIRE_TRAILER")
        [[ -n "$CG_OUTPUT_FILE" ]] && ARGS+=(--output-file "$CG_OUTPUT_FILE")
        commit-guard "${ARGS[@]}"
        if [[ -n "$CG_OUTPUT_FILE" ]]; then
          echo "output-file=$CG_OUTPUT_FILE" >> "$GITHUB_OUTPUT"
        fi
      shell: bash