Run PMD static analysis on your code and report issues as GitHub PR comments via reviewdog.

ℹ️ Note: This action only integrates PMD with reviewdog.
If you want GitHub annotations instead of reviewdog comments, use the original pmd-github-action.

By default, this action uses the github-pr-review reporter mode.
In this mode, reviewdog posts PMD findings as PR comments, which you can see in different tabs:

• Conversation tab

• Files Changed tab

name: PMD Check

on:
  pull_request:
    paths:
      - '**/*.java'

jobs:
  pmd-review:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v5

      - name: Set up Java
        uses: actions/setup-java@v5
        with:
          distribution: temurin
          java-version: 21

      - name: Run PMD + Reviewdog
        uses: RodionKorneev/pmd-reviewdog-action@v1
        with:
          rulesets: 'rulesets/java/quickstart.xml'

⚠️ Java must be installed on the runner, since PMD runs on the Java Virtual Machine.

This is not handled by the action itself because:

• The required Java version may vary between projects.
• Users may already have Java installed on the runner.
• GitHub-hosted runners or self-hosted runners may use different Java distributions.

Therefore, the action assumes that a compatible Java runtime is already available in the environment.

This action does not produce outputs, all results are reported via reviewdog in PR comments or GitHub checks.

This action is a composite GitHub Action that combines:

1. pmd/pmd-github-action — runs PMD static analysis.
2. reviewdog/action-setup — installs reviewdog CLI.

All inputs you provide to pmd-reviewdog-action are used as follows:

• rulesets, workdir, pmd_version, etc. → forwarded to pmd/pmd-github-action.
• tool_name, reporter, level, fail_level, filter_mode, reviewdog_flags → passed to the reviewdog CLI when reporting issues.

A few internal parameters are handled internally, but in general you can configure PMD analysis and reviewdog reporting in a way very similar to using the underlying tools directly.

This action is licensed under the MIT License © Rodion Korneev.