aikidosec/Aikido Security Github Action
This action triggers a scan in Aikido. It will throw an error if any new critical issues were found.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Maintainedlast commit May 8, 2025
- License
- MIT
Pinned Snippet
uses: aikidosec/github-actions-workflow@47d83dbcf3e6635044c4b31cef590c1e095217cc # v1.0.13tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| secret-key | Secret key provided by Aikido | yes | — |
| minimum-severity | Which minimum severity Aikido should detect. Can be one of the following: LOW, MEDIUM, HIGH, CRITICAL | no | CRITICAL |
| fail-on-timeout | Whether or not the action should fail when the scan does not complete within 2 minutes. | no | true |
| fail-on-dependency-scan | Whether or not the action should fail when the pull request introduced new dependency issues with critical severity | no | true |
| fail-on-iac-scan | Whether or not the action should fail when the pull request introduced new infrastructure as code issues are detected | no | false |
| fail-on-sast-scan | Whether or not the action should fail when the pull request introduced new SAST issues with critical severity | no | false |
| timeout-seconds | Provide a number of seconds the action will wait for scans to complete. | no | 120 |
| post-scan-status-comment | Let Aikido post a comment on the PR with a summary of the status, this comment will be updated for each scan. Can be one of "on", "off" or "only_if_new_findings". When setting this value to "only_if_new_findings" Aikido will only post a comment once new findings are found, and keep it updated afterwards. | no | off |
| post-sast-review-comments | Let Aikido post inline review comments for sast findings. Can be one of "on", "off". | no | off |
| github-token | A token that the action can use to post the status comment, this can be the default GITHUB_TOKEN from the environment with permissions to list and post comments, or a custom PAT. | no | "" |
Outputs
| name | description |
|---|---|
| outcome | 'The outcome of the scan. This will return `SUCCESS` in case we managed to do a scan and no new critical issues were found.\n When we did not get results back in time, within 2 minutes, we will return a `TIMEOUT` status but not let the action fail. In case we did detect a new critical issue, the action will fail and outcome will be `FAILED`' |
| scanResultUrl | A link to the scan results in Aikido. |