Merge pull request #45 from smetanink:main

Add an option to disable GitHub annotations (createGitHubAnnotations) #45

* pr-45:
  Add an option to disable GitHub annotations

Author: adangel

README.md

@@ -79,6 +79,7 @@ See also [Uploading a SARIF file to GitHub](https://docs.github.com/en/code-secu
 |`sourcePath`|no |"."     |Root directory for sources. Uses by default the current directory|
 |`rulesets`  |yes|        |Comma separated list of ruleset names to use.|
 |`analyzeModifiedFilesOnly`|no|"true"|Instead of analyze all files under "sourcePath", only the files that have been touched in a pull request or push will be analyzed. This makes the analysis faster and helps especially bigger projects which gradually want to introduce PMD. This helps in enforcing that no new code violation is introduced.<br>Depending on the analyzed language, the results might be less accurate results. At the moment, this is not a problem, as PMD mostly analyzes each file individually, but that might change in the future.<br>If the change is very big, not all files might be analyzed. Currently the maximum number of modified files is 300.<br>Note: When using PMD as a code scanner in order to create "Code scanning alerts" on GitHub, all files should be analyzed in order to produce a complete picture of the project. Otherwise alerts might get closed soo soon.|
+|`createGitHubAnnotations`|no|"true"|By default, all detected violations are added as annotations to the pull request. You can disable this by setting FALSE. This can be useful if you are using another tool for this purpose.|
 
 ## Outputs
 

action.yml

@@ -49,7 +49,14 @@ inputs:
       complete picture of the project. Otherwise alerts might get closed soo
       soon.
     required: false
-    default: true
+    default: 'true'
+  createGitHubAnnotations:
+    description: >-
+      By default, all detected violations are added as annotations to the pull 
+      request. You can disable this by setting FALSE. This can be useful if you 
+      are using another tool for this purpose.
+    required: false
+    default: 'true'
 outputs:
   violations:
     description: Number of violations found

dist/index.js

@@ -41,8 +41,10 @@ async function main() {
     core.setOutput('violations', violations);
     core.info(`PMD detected ${violations} violations.`);
 
-    const report = sarif.loadReport(reportFile);
-    annotations.processSarifReport(report);
+    if (core.getInput('createGitHubAnnotations', { required: true}) === 'true') {
+      const report = sarif.loadReport(reportFile);
+      annotations.processSarifReport(report);
+    }
 
     const artifactClient = artifact.create();
     await artifactClient.uploadArtifact('PMD Report', [reportFile], '.', {