actions-marketplace-validations/PMD Analyser
Runs PMD Source Code Analyser based on the ruleset defined - https://pmd.github.io/
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Maintainedlast commit Mar 11, 2025
- License
- MIT
Pinned Snippet
uses: actions-marketplace-validations/synergy-au_pmd-analyser-action@79a0960cf1abcecea554655d14a21f7a480055a3 # no releases — HEAD as of 2026-07-13tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| analyse-all-code | Used to determine whether you just want to analyse the files changed or the whole repository. | no | false |
| auth-token | If you are looking to compare the file difference based on the GitHub pull request, you will need to specify the [GitHub secrets token](https://docs.github.com/en/actions/reference/authentication-in-a-workflow) | no | — |
| error-rules | If you wish to define rules that log as an error, enter each rule name separated with a comma and no spaces. Note that if an error is identified the run will fail. e.g. ClassNamingConventions,GuardLogStatement | no | — |
| file-diff-type | Choose whether you want the file comparison to be based on a git diff or based on the files changed specified on the GitHub pull request. Note that if you use the GitHub pull request option, this action will only work on a pull request event. Options to set this are either `git` or `github`. | no | git |
| file-path | Path to the sources to analyse. This can be a file name, a directory, or a jar or zip file containing the sources. | yes | — |
| note-rules | If you wish to define rules that log as a note, enter each rule name separated with a comma and no spaces. Note that if a note is identified the run will not fail. e.g. ClassNamingConventions,GuardLogStatement | no | — |
| pmd-version | The version of PMD you would like to run. You can either specify latest to always get the newest version, or you can specify a version number like 6.37.0 | no | latest |
| rules-path | The ruleset file you want to use. PMD uses xml configuration files, called rulesets, which specify which rules to execute on your sources. You can also run a single rule by referencing it using its category and name (more details here). For example, you can check for unnecessary modifiers on Java sources with -R category/java/codestyle.xml/UnnecessaryModifier. | yes | — |
Outputs
| name | description |
|---|---|
| error-found | Identifies whether an error has been found based on the ruleset. |