actions-marketplace-validations/snyk-node
This action leverages Snyk Open Source to scan dependencies for known license issues and vulnerabilities.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| snyk_api_key | Expects a string value corresponding to the API key to use when accessing the Snyk organization. | yes | — |
| path_to_dependency_file | Expects the relative GitHub path to the dependency file to test. | yes | — |
| integrate_with_snyk_platform | If this is true, the repository will be integrated with the Snyk platform. | no | false |
| snyk_org_id | Expects a string value corresponding to the Snyk organization ID. It expects a GUID format. This is required if 'integrate_with_snyk_platform' is 'true'. | no | — |
| snyk_integration_id | Expects a string value corresponding to the Integration ID for a source control provider. This is required if 'integrate_with_snyk_platform' is 'true'. | no | — |
| repository | Expects the GitHub repository to import to the Snyk platform or post a GitHub Issue to. This is required if either 'integrate_with_snyk_platform', 'create_github_issues', or 'upload_sarif' is 'true'. | no | — |
| branch_name | Expects the GitHub repository branch name that should be imported into Snyk. This is required if 'integrate_with_snyk_platform' or 'upload_sarif' is 'true'. | no | — |
| create_github_issues | If this is true, details of the Snyk scan will be posted to the Issues tab of a repository. | no | false |
| upload_sarif | If this is true, details of the Snyk scan will be uploaded as a SARIF file to the Security tab of a repository. | no | false |
| github_issue_assignee | Expects a string value corresponding to the GitHub user to assign issues to if 'create_github_issues' is 'true'. | no | — |
| security_issues_labels | The labels that should be applied to security-related GitHub Issues if 'create_github_issues' is 'true'. | no | — |
| license_issues_labels | The labels that should be applied to license compliance-related GitHub Issues if 'create_github_issues' is 'true'. | no | — |
| snyk_github_integration_token | GitHub token to use for posting issues. This is required if 'create_github_issues' or 'upload_sarif' is 'true'. | no | — |
Outputs
no outputs