actions-marketplace-validations/Steampunk Spotter

An Ansible Playbook Scanning Tool that analyzes and offers recommendations for your Ansible Playbooks.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
endpointSteampunk Spotter API endpoint (instead of default https://api.spotter.steampunk.si/api).no
api_tokenSteampunk Spotter API token.no
usernameSteampunk Spotter username.no
passwordSteampunk Spotter password.no
timeoutSteampunk Spotter API timeout (in seconds).no
configPath to JSON/YAML configuration file.no
pathsList of paths to Ansible content files to be scanned. If not specified, the whole repository is scanned.no.
project_idID of an existing target project in the app, where the scan result will be stored. If not specified, the first project of the user's first organization (in the app) will be used.no
exclude_valuesOmits parsing and uploading values from Ansible playbooks.nofalse
exclude_metadataOmits collecting and uploading metadata (i.e., file names, line and column numbers).nofalse
display_levelDisplays check results with specified level or greater (e.g., warning will show all warnings and errors, but suppress hints). Available options: hint, warning, error.nohint
no_docs_urlOmits documentation URLs from the output.nofalse
no_scan_urlOmits scan URL from the output.notrue
ansible_versionAnsible version to use for scanning. If not specified, all Ansible versions are considered for scanning.no
profileSets profile with selected set of checks to be used for scanning.nodefault
skip_checksSkips checks with specified IDs.no
enforce_checksEnforce checks with specified IDs.no
custom_policies_pathPath to the file or folder with custom OPA policies written in Rego Language (enterprise feature).no
custom_policies_clearClears OPA policies for custom Spotter checks after scanning (enterprise feature).nofalse
debugEnable debug output.no
sarif_fileSets the name of the SARIF file and triggers the creation of the SARIF report.no
namedescription
outputOutput from scanning (from spotter scan CLI command).