// tag::enable-checkstyle-sarif-report[]
checkstyle {
    toolVersion = '10.3.3'
}
// end::enable-checkstyle-sarif-report[]

// tag::enable-checkstyle-sarif-report[]
// tag::customize-checkstyle-report[]
tasks.withType(Checkstyle) {
    reports {
// end::customize-checkstyle-report[]
        sarif.required = true
// end::enable-checkstyle-sarif-report[]
// tag::customize-checkstyle-report[]

      # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
      # format to the repository Actions tab.
      - name: "Upload artifact"
        uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3
        with:
          name: SARIF file
          path: results.sarif
          retention-days: 5

      # Upload the results to GitHub's code scanning dashboard.

    }

    def "can configure sarif reporting"() {
        given:
        Assume.assumeTrue(isSarifSupported())
        goodCode()

        when:
        buildFile << """
            checkstyleMain.reports {
                sarif {
                    required = true
                    sarif.outputLocation = file("baz.sarif")
                }
            }
        """

// tag::enable-checkstyle-sarif-report[]
checkstyle {
    toolVersion = "10.3.3"
}
// end::enable-checkstyle-sarif-report[]

// tag::enable-checkstyle-sarif-report[]
// tag::customize-checkstyle-report[]
tasks.withType<Checkstyle>().configureEach {
    reports {
// end::customize-checkstyle-report[]
        sarif.required = true
// end::enable-checkstyle-sarif-report[]
// tag::customize-checkstyle-report[]

        with:
          name: SARIF file
          path: results.sarif
          retention-days: 5

      # Upload the results to GitHub's code scanning dashboard.
      - name: "Upload to code-scanning"
        uses: github/codeql-action/upload-sarif@896079047b4bb059ba6f150a5d87d47dde99e6e5 # v2.11.6
        with:

[[sec:enable_checkstyle_sarif]]
== Generate SARIF report

link:https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html[SARIF] report is supported on Checkstyle versions 10.3.3 and newer. It is not enabled by default.

.Enable SARIF Report
====
include::sample[dir="snippets/codeQuality/codeQuality/kotlin",files="build.gradle.kts[tags=enable-checkstyle-sarif-report]"]

            !reports.html.required.get()
            !reports.html.outputLocation.isPresent()
            reports.html.outputType == Report.OutputType.FILE
            !reports.sarif.required.get()
            !reports.sarif.outputLocation.isPresent()
            reports.sarif.outputType == Report.OutputType.FILE
            !ignoreFailures
            showViolations
            maxErrors == 0
            maxWarnings == Integer.MAX_VALUE

        add(CustomizableHtmlReportImpl.class, "html", task);
        add(TaskGeneratedSingleFileReport.class, "xml", task);
        add(TaskGeneratedSingleFileReport.class, "sarif", task);
    }

    @Override
    public CustomizableHtmlReport getHtml() {
        return withType(CustomizableHtmlReport.class).getByName("html");
    }

    @Override
    public SingleFileReport getXml() {

     *
     * @return The checkstyle XML report
     */
    @Internal
    SingleFileReport getXml();

    /**
     * The checkstyle SARIF report
     * <p>
     * This report is NOT enabled by default.
     *
     * @return The checkstyle SARIF report
     * @since 8.1
     */
    @Internal
    @Incubating
    SingleFileReport getSarif();

        task.reports.html.outputLocation.asFile.get() == project.file("build/reports/checkstyle/custom.html")
        task.reports.sarif.outputLocation.asFile.get() == project.file("build/reports/checkstyle/custom.sarif")
        !task.ignoreFailures
    }

    def "adds checkstyle tasks to check lifecycle task"() {
        project.pluginManager.apply(JavaBasePlugin)