diff --git a/README.md b/README.md index a3fb0ab..719a984 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/docs/images/html-output-exmple.png b/docs/images/html-output-exmple.png index b1bff37..3b6a2bd 100644 Binary files a/docs/images/html-output-exmple.png and b/docs/images/html-output-exmple.png differ