action.yaml

# action.yml
name: 'Nosey Parker'
description: 'Scan repository for secrets'
inputs:
  local-output:
    description: 'echo human-readable findings to console'
    required: false
    default: 'true'
  report-name:
    description: 'File name for the reports without the extension'
    required: false
    default: 'report'
  report-format-human:
    description: 'upload human readable (txt) formatted report'
    required: false
    default: 'false'
  report-format-json:
    description: 'upload json formatted report'
    required: false
    default: 'false'
  report-format-jsonl:
    description: 'upload jsonl formatted report'
    required: false
    default: 'false'
  report-format-sarif:
    description: 'upload sarif formatted report'
    required: false
    default: 'false'
  scan-directory:
    description: 'relative directory of the repo to scan from $GITHUB_WORKSPACE'
    required: false
    default: 'main'
  fail-on-finding:
    description: 'set to true to interrupt the pipeline if there are any findings'
    required: false
    default: 'false'
  scan-args:
    description: 'Arguments to pass to scan - this is passed after datastore and scan-directory are specified. Arguments like --github-user will override the scan directory for local scanning.'
    required: false
    default: ''
outputs:
  time: # id of output
    description: 'The initial runtime.'
  np_status_code:
    description: 'Status code of the noseyparker scan command.'
  np_status:
    description: 'Descriptive status of noseyparker scan command.'
  # np_summary:
  #   description: 'Output of noseyparker summary command.'
  # np_report:
  #   description: 'Output of noseparker report command.'


runs:
  using: 'docker'
  image: 'Dockerfile'
  args:
    - ${{ inputs.local-output }}
    - ${{ inputs.report-name }}
    - ${{ inputs.report-format-human }}
    - ${{ inputs.report-format-json }}
    - ${{ inputs.report-format-jsonl }}
    - ${{ inputs.report-format-sarif }}
    - ${{ inputs.scan-directory }}
    - ${{ inputs.fail-on-finding }}
    - ${{ inputs.scan-args }}