pmd / pmd-github-action

GitHub Action for PMD
MIT License
39 stars 25 forks source link

Support reports in other formats #169

Open miltlima opened 1 year ago

miltlima commented 1 year ago

Hello Folks !!

Is there any way to specify the type of report in the action ? per example , can i do this

 - uses: pmd/pmd-github-action@v1
      id: pmd
      with:
        version: '6.40.0'
        sourcePath: 'src/main/java'
        rulesets: 'rulesets/java/quickstart.xml,ruleset.xml'
        reportFile: 'pmd-report.xlst' "Or another report file extension"

Thanks!

adangel commented 1 year ago

Hi @miltlima, thanks for reaching out.

Currently, this github action will only create a report in sarif format. This format is kind of a standard for static analyzer tools and is natively supported by github's codeql.

If you don't need this feature, we could enhance this action to provide a parameter to specify the report format. Currently there is no such parameter (see inputs for the list of available parameters). Naturally, only the report format that PMD can produce, can be selected. See PMD Report Formats for a list of available formats.