action.yml

name: helmdoc scan
description: Install a published helmdoc release and run helmdoc scan against a Helm chart.
inputs:
  chart-path:
    description: Path to the Helm chart to analyze.
    required: true
  version:
    description: Released helmdoc tag to install; use latest to resolve the newest GitHub Release.
    required: false
    default: latest
  output:
    description: Scan output format to request from helmdoc (text or json).
    required: false
    default: text
  min-score:
    description: Optional minimum acceptable grade (A, B, C, D, or F).
    required: false
    default: ""
  config:
    description: Optional path to a .helmdoc.yaml policy file.
    required: false
    default: ""
runs:
  using: composite
  steps:
    - name: Install helmdoc release
      shell: bash
      run: |
        set -euo pipefail
        "${GITHUB_ACTION_PATH}/scripts/install-helmdoc-release.sh" --version "${{ inputs.version }}"

    - name: Run helmdoc scan
      shell: bash
      run: |
        set -euo pipefail
        args=("scan" "${{ inputs.chart-path }}")
        if [[ -n "${{ inputs.output }}" ]]; then
          args+=("--output" "${{ inputs.output }}")
        fi
        if [[ -n "${{ inputs.min-score }}" ]]; then
          args+=("--min-score" "${{ inputs.min-score }}")
        fi
        if [[ -n "${{ inputs.config }}" ]]; then
          args+=("--config" "${{ inputs.config }}")
        fi
        printf 'action: helmdoc %s\n' "${args[*]}"
        helmdoc "${args[@]}"