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

Add mention about sarif-tools - conversion tool 🐢 #404

Merged
merged 3 commits into from
May 6, 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
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ Differential ShellCheck exposes following [outputs](https://docs.github.com/en/a

### sarif

Relative path to SARIF file containing detected defects. Example of use:
Relative path to the SARIF file containing detected defects. Example of how to use `sarif` output within the workflow:

```yaml
- id: ShellCheck
Expand All @@ -343,9 +343,13 @@ Relative path to SARIF file containing detected defects. Example of use:
sarif_file: ${{ steps.ShellCheck.outputs.sarif }}
```

> [!TIP]
>
> `sarif` output can be used together with tools like [`microsoft/sarif-tools`](https://github.com/microsoft/sarif-tools?tab=readme-ov-file#sarif-tools) to convert SARIF to other formats like `codeclimate`, `csv`, `docx` and more. [Example of use](https://github.com/microsoft/sarif-tools?tab=readme-ov-file#suggested-usage-in-ci-pipelines).

### html

Relative path to HTML file containing detected defects. Example of use:
Relative path to the HTML file containing detected defects. Example of how to use `html` output within the workflow:

```yaml
- id: ShellCheck
Expand Down
Binary file modified docs/images/html-output-exmple.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.