Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document SARIF options for Snyk test #48

Merged
merged 3 commits into from
Apr 20, 2021
Merged

Document SARIF options for Snyk test #48

merged 3 commits into from
Apr 20, 2021

Conversation

JackuB
Copy link
Contributor

@JackuB JackuB commented Apr 14, 2021

You can preview this branch here: https://github.com/snyk/actions/tree/feat/oss-sarif

This PR documents the SARIF upload step for all Actions, except for the Docker and IAC which already implements it.

Because of a requirements for --file for the Docker scanning, we choose not to implement the input option for sarif, but rather are nudging users to use the standard CLI flags and the official GitHub's Action for SARIF upload.

We've considered embedding the upload into the Snyk Action, but GitHub Actions don't support composite actions actions/runner#646

Closes #47

README.md Outdated Show resolved Hide resolved

If you want to send data to Snyk, and be alerted when new vulnerabilities are discovered, you can run Snyk monitor like so:

If you want to send data to Snyk, and be alerted when new vulnerabilities are discovered, you can run [Snyk monitor](https://support.snyk.io/hc/en-us/articles/360000920818-What-is-the-difference-between-snyk-test-protect-and-monitor-) like so:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you want to send data to Snyk, and be alerted when new vulnerabilities are discovered, you can run [Snyk monitor](https://support.snyk.io/hc/en-us/articles/360000920818-What-is-the-difference-between-snyk-test-protect-and-monitor-) like so:
If you want to send data to Snyk, and be alerted when new vulnerabilities are discovered, you can run [`snyk monitor`](https://support.snyk.io/hc/en-us/articles/360000920818-What-is-the-difference-between-snyk-test-protect-and-monitor-) like so:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like doing that, because GH makes the link almost invisible in code blocks

Copy link

@maxjeffos maxjeffos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made a bunch of comments / suggestions. Feel free to disregard if you don't like them.

README.md Show resolved Hide resolved
_templates/README.md.erb Outdated Show resolved Hide resolved
dotnet/README.md Outdated Show resolved Hide resolved
dotnet/README.md Outdated Show resolved Hide resolved
dotnet/README.md Outdated Show resolved Hide resolved
@JackuB JackuB merged commit 5fd709b into master Apr 20, 2021
@JackuB JackuB deleted the feat/oss-sarif branch April 20, 2021 12:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants