Skip to content

SARIF

Report name: sarif

Available in all: No

Report that generates SARIF output file.

SARIF is a JSON-based standard for the representation of results from static analysis tools. It is supported by different platforms and tools such as GitHub or SonarQube.

Enable with:

robocop check --reports sarif

[tool.robocop.lint]
reports = [
    "sarif"
]

It will create .sarif.json file in the current directory.

Configuration

Output path

You can configure an output path with the output_path option. It's a relative path to the file that will be produced by the report:

robocop check --reports sarif --configure sarif.output_path=output/sarif.json

[tool.robocop.lint]
reports = [
    "sarif"
]
configure = [
    "sarif.output_path=output/sarif.json"
]

The default path is .sarif.json.

Skip on empty

By default, the report file is generated even if Robocop did not find any issue. Set the skip_on_empty option to True to not create the file when there is nothing to report:

robocop check --reports sarif --configure sarif.skip_on_empty=True

[tool.robocop.lint]
reports = [
    "sarif"
]
configure = [
    "sarif.skip_on_empty=True"
]

If the file was created by a previous run, it is left untouched.