devinshawntripp/ScanRook Scan
Install ScanRook and scan a local artifact (tar/iso/bin) or Docker image in CI.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| artifact_path | Path to artifact to scan. | no | "" |
| image | Docker image to scan (alternative to artifact_path). Will be pulled and saved as tar. | no | "" |
| mode | Scan mode: light or deep. | no | deep |
| format | Output format: json or text. | no | json |
| out_file | Report file path when format=json. | no | scanrook-report.json |
| refs | Enable reference/enrichment output (true|false). | no | true |
| version | Release version to install. Use latest by default. | no | latest |
| api_base | Optional ScanRook API base URL. | no | https://scanrook.io |
| api_key | Optional ScanRook API key for cloud enrichment. | no | "" |
| fail_on_critical | Fail the action if critical severity findings exceed this count. Set to -1 to disable. | no | 0 |
| fail_on_high | Fail the action if high severity findings exceed this count. Set to -1 to disable. | no | -1 |
| fail_on_total | Fail the action if total findings exceed this count. Set to -1 to disable. | no | -1 |
| comment_on_pr | Post scan summary as PR comment (true|false). Requires GITHUB_TOKEN. | no | true |
| github_token | GitHub token for posting PR comments. Defaults to github.token. | no | ${{ github.token }} |
Outputs
| name | description |
|---|---|
| report_path | Path to generated report when format=json. |
| critical_count | Number of critical findings. |
| high_count | Number of high findings. |
| total_count | Number of total findings. |
| policy_failed | Whether the policy gate failed (0 or 1). |