Apex PMD GitHub Actions

[jurgenvanwestreenen]

Hello,

I'm trying to get the PMD Github Action to work, but I'm currently stuck.

When running the workflow it detects a changed file, but when running the PMD check it reports there is "no such file".

I'm using attached yml (PMD.yml.txt), which seems alright, but the log then shows the following:

Run pmd/pmd-github-action@v1
  with:
    sourcePath: force-app/main/default/classes
    rulesets: rulesets/apex/quickstart.xml
    token: ***
    version: latest
    analyzeModifiedFilesOnly: true
    createGitHubAnnotations: true
  env:
    JAVA_HOME: /opt/hostedtoolcache/Java_Temurin-Hotspot_jdk/11.0.15-10/x64
/usr/bin/unzip -o -q /home/runner/work/_temp/99a67231-1bd5-46d4-b81a-471adfaa8898
Using PMD 6.47.0 from cached path /opt/hostedtoolcache/pmd/6.47.0/x64
Determining modified files in force-app/main/default/classes...
Running PMD 6.47.0 on 1 modified files...
/opt/hostedtoolcache/pmd/6.47.0/x64/pmd-bin-6.47.0/bin/run.sh pmd --no-cache --file-list pmd.filelist -f sarif -R rulesets/apex/quickstart.xml -r pmd-report.sarif
Jul 13, 2022 9:05:32 AM net.sourceforge.pmd.util.log.internal.SimpleMessageReporter logImpl
SEVERE: No such file force-app/main/default/classes/BotController.cls
PMD exited with 0
PMD detected 0 violations.

Please advise

Regards,

Jurgen

PMD.yml:

name: PMD Source Code Analyzer on PR

on:
  pull_request:
    branches:    
      - master

jobs:
  pmd:
  
    runs-on: ubuntu-latest
    
    steps:
      - uses: actions/setup-java@v2
        with:
          java-version: '11'
          distribution: 'temurin'
      - uses: pmd/pmd-github-action@v1
        id: pmd
        with:
          sourcePath: 'force-app/main/default/classes'
          rulesets: 'rulesets/apex/quickstart.xml'
      - name: Fail build if there a violations
        if: steps.pmd.outputs.violations != 0
        run: exit 1

[adangel]

Hi @jurgenvanwestreenen ,

I couldn't reproduce your problem - there doesn't seem to be a general problem. E.g. pmd/pmd-github-action-tests#8 works as expected (I also used the sourcePath parameter here).

The action uses the GitHub API to determine the files, that have been modified in the PR - that's how we figure out, that force-app/main/default/classes/BotController.cls needs to be analyzed.

But the error "No such file" we print only, if there is indeed no such file... Until now, we didn't access the local file system, we just used the GitHub API.

Looking further, I'm missing in your workflow the step to checkout the repository... That's what I've done in the Test PR, I've created. I guess, that's the problem here.

So, just add - uses: actions/checkout@v2 before "setup-java" and it should work.

Regards,
Andreas

[jurgenvanwestreenen]

Hi @adangel ,

That actually indeed did the trick. Now it performs the check nicely on the changed file. Thank you very much!

One follow-up question though: How can we use a custom ruleset?
Currently it seems to be referencing some external repository, but I want to use a ruleset stored in my own (remote) repository.

I tried placing the custom ruleset.xml in the root of the repository and then reference it as "ruleset.xml" (also tried "./ruleset.xml"), but I keep getting a "no ruleset found" error.

Regards.

Jurgen

[jurgenvanwestreenen]

FYI: It turned out the added checkout step also solved the ruleset issue. One again thank you for the help.

[adangel]

Thanks for the feedback!