Make uploading artifacts optional (#23)

* Make uploading artifacts optional

This allows users to execute this action even if they dont have
permissions to upload artifacts to the target repo of their PR.
This is usually the case when creating PRs from forks because by default
github limits permissons for workflows that are not yet part of the
target repo.

Signed-off-by: Balaji Srinivasan <balaji.srinivasan@nordicsemi.no>

* Clean up

* Update action.yml

Co-authored-by: Zennon Gosalvez <1798166+zgosalvez@users.noreply.github.com>

Author: Balaji Srinivasan

README.md

@@ -13,7 +13,7 @@ Create a workflow `.yml` file in your `.github/workflows` directory. An [example
 For more information on these inputs, see the [Workflow syntax for GitHub Actions](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepswith)
 
 - `coverage-files`: The coverage files to scan. For example, `coverage/lcov.*.info`
-- `artifact-name`: The GitHub artifact name of the generated HTML report. For example, `code-coverage-report`. _Note:_ When downloading, it will be extracted in an `html` directory
+- `artifact-name`: The GitHub artifact name of the generated HTML report. For example, `code-coverage-report`. _Note:_ When downloading, it will be extracted in an `html` directory. Optional. Default: `` (Skips uploading of artifacts)
 - `minimum-coverage`: The minimum coverage to pass the check. Optional. Default: `0` (always passes)
 - `github-token`: Set the `${{ secrets.GITHUB_TOKEN }}` token to have the action comment the coverage summary in the pull request. This token is provided by Actions, you do not need to create your own token. Optional. Default: ``
 - `working-directory`: The working directory containing the source files referenced in the LCOV files. Optional. Default: `./`

action.yml

@@ -8,8 +8,7 @@ inputs:
     description: 'The coverage files to scan. For example, `coverage/lcov.*.info`'
     required: true
   artifact-name:
-    description: 'The GitHub artifact name of the generated HTML report. For example, `code-coverage-report`. _Note:_ When downloading, it will be extracted in an `html` directory'
-    required: true
+    description: 'The GitHub artifact name of the generated HTML report. For example, `code-coverage-report`. _Note:_ When downloading, it will be extracted in an `html` directory. Optional. Default: `` (Skips uploading of artifacts)'
   minimum-coverage:
     description: 'The minimum coverage to pass the check. Optional. Default: `0` (always passes)'
     default: 0

dist/main/index.js

@@ -64,17 +64,23 @@ async function genhtml(coverageFiles, tmpPath) {
 
   await exec.exec('genhtml', args, { cwd: workingDirectory });
 
-  const globber = await glob.create(`${artifactPath}/**`);
-  const htmlFiles = await globber.glob();
-
-  await artifact
-    .create()
-    .uploadArtifact(
-      artifactName,
-      htmlFiles,
-      artifactPath,
-      { continueOnError: false },
-    );
+  if (artifactName !== '') {
+    const globber = await glob.create(`${artifactPath}/**`);
+    const htmlFiles = await globber.glob();
+
+    core.info(`Uploading artifacts.`);
+
+    await artifact
+      .create()
+      .uploadArtifact(
+        artifactName,
+        htmlFiles,
+        artifactPath,
+        { continueOnError: false },
+      );
+  } else {
+    core.info("Skip uploading artifacts");
+  }
 }
 
 async function mergeCoverages(coverageFiles, tmpPath) {