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

feat: use SARIF format #40

Merged
merged 1 commit into from
Jun 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,50 +31,56 @@ the Pull Request Conversation:

### `github_token`

**Required**. Must be in form of `github_token: ${{ secrets.github_token }}`.
**Required**.

The default is `${{ github.token }}`.

### `trivy_command`

**Required**. Trivy command [`aws`, `config`, `filesystem`, `image`, `kubernetes`, `rootfs`, `sbom`, `vm`].
**Required**. Trivy command [`aws`, `config`, `filesystem`, `image`, `kubernetes`, `rootfs`, `sbom`, `vm`].
You can see this with `trivy --help`

### `trivy_target`

**Required**. Target to scan.
It's depends on the command. Please check [Trivy Docs](https://aquasecurity.github.io/trivy/latest/docs/)
Varies depending on the `trivy_command` chosen. Please check [Trivy Docs](https://aquasecurity.github.io/trivy/latest/docs/)

### `working_directory`

Optional. Directory to run the action on, from the repo root.
The default is `.` ( root of the repository).

The default is `.` (root of the repository).

### `level`

Optional. Report level for reviewdog [`info`,`warning`,`error`].
Optional. Report level for reviewdog [`info`, `warning`, `error`].
It's same as `-level` flag of reviewdog.

The default is `error`.

### `tool_name`

Optional. Name of the tool being used. This controls how it will show up in the GitHub UI.

The default is `trivy`.

### `reporter`

Optional. Reporter of reviewdog command [`github-pr-check`,`github-pr-review`].
Optional. Reporter of reviewdog command [`github-pr-check`, `github-pr-review`].

The default is `github-pr-check`.

### `filter_mode`

Optional. Filtering for the reviewdog command [`added`,`diff_context`,`file`,`nofilter`].
Optional. Filtering for the reviewdog command [`added`, `diff_context`, `file`, `nofilter`].

The default is `added`.

See [reviewdog documentation for filter mode](https://github.com/reviewdog/reviewdog/tree/master#filter-mode) for details.

### `fail_on_error`

Optional. Exit code for reviewdog when errors are found [`true`,`false`].
Optional. Exit code for reviewdog when errors are found [`true`, `false`].

The default is `false`.

Expand All @@ -83,17 +89,19 @@ See [reviewdog documentation for exit codes](https://github.com/reviewdog/review
### `flags`

Optional. Additional reviewdog flags. Useful for debugging errors, when it can be set to `-tee`.

The default is ``.

### `trivy_version`

Optional. The version of trivy to install.

The default is `latest`.

### `trivy_flags`

Optional. List of arguments to send to trivy.
For the output to be parsable by reviewdog [`--format=checkstyle` is enforced](./entrypoint.sh).

The default is ``.

## Outputs
Expand Down
7 changes: 3 additions & 4 deletions script.sh
Original file line number Diff line number Diff line change
Expand Up @@ -102,17 +102,16 @@ echo '::group:: Running trivy with reviewdog 🐶 ...'
set +Eeuo pipefail

# shellcheck disable=SC2086
"${TRIVY_PATH}/trivy" --format json ${INPUT_TRIVY_FLAGS:-} --exit-code 1 ${INPUT_TRIVY_COMMAND} ${INPUT_TRIVY_TARGET} 2> /dev/null \
| jq -r -f "${GITHUB_ACTION_PATH}/to-rdjson.jq" \
| "${REVIEWDOG_PATH}/reviewdog" -f=rdjson \
"${TRIVY_PATH}/trivy" --format sarif ${INPUT_TRIVY_FLAGS:-} --exit-code 1 ${INPUT_TRIVY_COMMAND} ${INPUT_TRIVY_TARGET} 2> /dev/null \
| "${REVIEWDOG_PATH}/reviewdog" -f=sarif \
-name="${INPUT_TOOL_NAME}" \
-reporter="${INPUT_REPORTER}" \
-level="${INPUT_LEVEL}" \
-fail-on-error="${INPUT_FAIL_ON_ERROR}" \
-filter-mode="${INPUT_FILTER_MODE}" \
${INPUT_FLAGS}

trivy_return="${PIPESTATUS[0]}" reviewdog_return="${PIPESTATUS[2]}" exit_code=$?
trivy_return="${PIPESTATUS[0]}" reviewdog_return="${PIPESTATUS[1]}" exit_code=$?
echo "trivy-return-code=${trivy_return}" >> "$GITHUB_OUTPUT"
echo "reviewdog-return-code=${reviewdog_return}" >> "$GITHUB_OUTPUT"
echo '::endgroup::'
Expand Down
42 changes: 0 additions & 42 deletions to-rdjson.jq

This file was deleted.

Loading