action.yml

#   ########################################################################
#   Copyright 2021 Splunk Inc.
#
#    Licensed under the Apache License, Version 2.0 (the "License");
#    you may not use this file except in compliance with the License.
#    You may obtain a copy of the License at
#
#        http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS,
#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#    See the License for the specific language governing permissions and
#    limitations under the License.
#   ######################################################################## 
# action.yml
name: "Addon Factory Sample Scanner"
description: "Detect potentially sensitive data in samples"
runs:
  using: "docker"
  env:
    INPUT_SCANDIR: "${{ inputs.ScanDir }}"
  image: "docker://ghcr.io/splunk/addonfactory-sample-scanner:v1.3.2"
inputs:
  args:
    description: Additional arguments to the scanner
    required: false
  WorkDir:
    description: Set the scan directory relative to the project
    required: false
    default: tests/knowledge
  ### Flags for reviewdog ###
  github_token:
    description: "GITHUB_TOKEN"
    default: "${{ github.token }}"
  level:
    description: "Report level for reviewdog [info,warning,error]"
    default: "error"
  reporter:
    description: "Reporter of reviewdog command [github-pr-check,github-pr-review]."
  filter_mode:
    description: |
      Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
      Default is added.
    default: "added"
  fail_on_error:
    description: |
      Exit code for reviewdog when errors are found [true,false]
      Default is `false`.
    default: "false"
  reviewdog_flags:
    description: "Additional reviewdog flags"
    default: ""
branding:
  icon: "check"
  color: "blue"