Merge pull request #250 from adangel/fix-artifact-upload

Fix artifact upload, new parameter `uploadSarifReport`

README.md

@@ -83,6 +83,7 @@ See also [Uploading a SARIF file to GitHub](https://docs.github.com/en/code-secu
 |`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 too 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.|
+|`uploadSarifReport`|no|"true"|By default, the generated SARIF report will be uploaded as an artifact named "PMD Report". This can be disabled, e.g. if there are multiple executions on multiple os of this action.|
 
 ## Outputs
 

action.yml

@@ -82,6 +82,13 @@ inputs:
  are using another tool for this purpose.
  required: false
  default: 'true'
+ uploadSarifReport:
+ description: >-
+ By default, the generated SARIF report will be uploaded as an artifact
+ named "PMD Report". This can be disabled, e.g. if there are multiple
+ executions on multiple os of this action.
+ required: false
+ default: 'true'
 outputs:
  violations:
  description: Number of violations found

lib/index.js

@@ -1,5 +1,5 @@
 const core = require('@actions/core');
-const artifact = require('@actions/artifact');
+const {DefaultArtifactClient} = require('@actions/artifact');
 const util = require('./util');
 const sarif = require('./sarif');
 const validator = require('./validator');
@@ -43,15 +43,17 @@ async function main() {
  core.setOutput('violations', violations);
  core.info(`PMD detected ${violations} violations.`);
 
- if (core.getInput('createGitHubAnnotations', { required: true}) === 'true') {
+ if (core.getInput('createGitHubAnnotations', { required: false }) === 'true') {
  const report = sarif.loadReport(reportFile);
  annotations.processSarifReport(report);
  }
 
- const artifactClient = artifact.create();
- await artifactClient.uploadArtifact('PMD Report', [reportFile], '.', {
- continueOnError: false
- });
+ if (core.getInput('uploadSarifReport', { required: false }) === 'true' ) {
+ const artifactName = 'PMD Report';
+ const artifactClient = new DefaultArtifactClient();
+ const {id, size} = await artifactClient.uploadArtifact('PMD Report', [reportFile], '.');
+ core.info(`Created artifact ${artifactName} with id: ${id} (bytes: ${size})`)
+ }
  } catch (error) {
  core.setFailed(error.message || error);
  }