Initial PMD support

.github/workflows/test.yml

@@ -20,4 +20,4 @@ jobs:
     - uses: actions/checkout@v2
     - uses: ./
       with: 
-        path: '**/spotbugsXml.xml'
+        path: '**/pmd.xml'

README.md

@@ -1,10 +1,10 @@
-![build-test](https://github.com/jwgmeligmeyling/spotbugs-github-action/workflows/build-test/badge.svg)
+![build-test](https://github.com/jwgmeligmeyling/pmd-github-action/workflows/build-test/badge.svg)
 
-# SpotBugs GitHub Action
+# PMD GitHub Action
 
-This action pushes results from [SpotBugs](https://spotbugs.github.io/) (or [FindBugs](http://findbugs.sourceforge.net/)) as check run annotations. :rocket:
+This action pushes results from [PMD](https://pmd.github.io/) as check run annotations. :rocket:
 
-The action can also be used for any other static analysis tools that produce reports in the SpotBugs XML format.
+The action can also be used for any other static analysis tools that produce reports in the PMD XML format.
 The report itself must be generated in a former build step, for example a Maven build.
 
 ![example](images/example.png)
@@ -13,13 +13,13 @@ The report itself must be generated in a former build step, for example a Maven
 
 ### `path`
 Required. A file, directory or wildcard pattern that describes where to find the reports.
-Multiple files can be processed through a [glob expression](https://github.com/actions/toolkit/tree/master/packages/glob), for example: `'**/spotbugsXml.xml'`.
+Multiple files can be processed through a [glob expression](https://github.com/actions/toolkit/tree/master/packages/glob), for example: `'**/pmd.xml'`.
 
 ### `name`
-Optional. Name for the check run to create. Defaults to `spotbugs`.
+Optional. Name for the check run to create. Defaults to `PMD`.
 
 ### `title`
-Optional. Title for the check run to create. Defaults to `SpotBugs Source Code Analyzer report`.
+Optional. Title for the check run to create. Defaults to `PMD Source Code Analyzer report`.
 
 ### `token`
 Optional. GitHub API access token. Defaults to `${{ github.token }}`, which is set by `actions/checkout@v2` minimally.
@@ -47,10 +47,10 @@ jobs:
         restore-keys: |
           ${{ runner.os }}-maven-
     - name: Build with Maven
-      run: mvn -B verify spotbugs:spotbugs
-    - uses: jwgmeligmeyling/spotbugs-github-action@v1
+      run: mvn -B verify pmd:pmd
+    - uses: jwgmeligmeyling/pmd-github-action@v1
       with:
-        path: '**/spotbugsXml.xml'
+        path: '**/pmd.xml'
 ```
 
 And do not forget to enable XML output for the Maven plugin:
@@ -59,12 +59,13 @@ And do not forget to enable XML output for the Maven plugin:
 <build>
   <plugins>
     <plugin>
-      <groupId>com.github.spotbugs</groupId>
-      <artifactId>spotbugs-maven-plugin</artifactId>
-      <version>4.0.0</version>
+      <groupId>org.apache.maven.plugins</groupId>
+      <artifactId>maven-pmd-plugin</artifactId>
+      <version>3.13.0</version>
       <configuration>
-        <xmlOutput>true</xmlOutput>
-        <failOnError>false</failOnError>
+        <includeTests>true</includeTests>
+        <failOnViolation>false</failOnViolation>
+        <skipEmptyReport>false</skipEmptyReport>
       </configuration>
     </plugin>
   </plugins>

__tests__/main.test.ts

@@ -9,12 +9,7 @@ beforeAll(() => {
 })
 
 test('parses file', async () => {
-  const spotBugsXml = path.resolve(
-    __dirname,
-    '..',
-    'reports',
-    'spotbugsXml.xml'
-  )
+  const spotBugsXml = path.resolve(__dirname, '..', 'reports', 'pmd.xml')
   const annotations = annotationsForPath(spotBugsXml)
-  expect(annotations).toHaveLength(12)
+  expect(annotations).toHaveLength(171)
 })

action.yml

@@ -1,16 +1,16 @@
-name: 'Push SpotBugs report'
-description: 'Push SpotBugs Code Analysis report'
+name: 'Push PMD report'
+description: 'Push PMD Code Analysis report'
 author: 'Jan-Willem Gmelig Meyling'
 inputs:
   path:
     description: 'A file, directory or wildcard pattern that describes where to find the reports'
     required: true
   name:
     description: 'Check run name under which the report is created'
-    default: spotbugs
+    default: PMD
   title:
     description: 'Check run title under which the report is created'
-    default: SpotBugs Source Code Analyzer report
+    default: PMD Source Code Analyzer report
   token:
     description: >
       Personal access token (PAT) used to fetch the repository. The PAT is configured