Merge pull request #3 from aeisenberg/aeisenberg/add-ref-input

Update the description of new inputs
cw-alexcroteau · Feb 1, 2022 · 9bfa05f · 9bfa05f
2 parents 72f9a88 + 6c6b8c3
commit 9bfa05f
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 6 deletions.
diff --git a/analyze/action.yml b/analyze/action.yml
@@ -46,10 +46,10 @@ inputs:
     required: false
     default: ${{ github.workspace }}
   ref:
-    description: "The ref where results will be uploaded. If not provided, the Action will use the GITHUB_REF environment variable. If provided, the sha input must be provided as well."
+    description: "The ref where results will be uploaded. If not provided, the Action will use the GITHUB_REF environment variable. If provided, the sha input must be provided as well. This input is not available in pull requests from forks."
     required: false
   sha:
-    description: "The sha of the HEAD of the ref where results will be uploaded. If not provided, the Action will use the GITHUB_SHA environment variable. If provided, the ref input must be provided as well."
+    description: "The sha of the HEAD of the ref where results will be uploaded. If not provided, the Action will use the GITHUB_SHA environment variable. If provided, the ref input must be provided as well. This input is not available in pull requests from forks."
     required: false
   category:
     description: String used by Code Scanning for matching the analyses

diff --git a/lib/actions-util.js b/lib/actions-util.js
diff --git a/lib/actions-util.js.map b/lib/actions-util.js.map
diff --git a/lib/upload-lib.js b/lib/upload-lib.js
diff --git a/lib/upload-lib.js.map b/lib/upload-lib.js.map
diff --git a/src/actions-util.ts b/src/actions-util.ts
@@ -618,6 +618,12 @@ export async function sendStatusReport<S extends StatusReportBase>(
 ): Promise<boolean> {
   const statusReportJSON = JSON.stringify(statusReport);
   core.debug(`Sending status report: ${statusReportJSON}`);
+  // If in test mode we don't want to upload the results
+  const testMode = process.env["TEST_MODE"] === "true" || false;
+  if (testMode) {
+    core.debug("In test mode. Status reports are not uploaded.");
+    return true;
+  }
 
   const nwo = getRequiredEnvParam("GITHUB_REPOSITORY");
   const [owner, repo] = nwo.split("/");

diff --git a/src/upload-lib.ts b/src/upload-lib.ts
@@ -100,6 +100,7 @@ async function uploadPayload(
   // If in test mode we don't want to upload the results
   const testMode = process.env["TEST_MODE"] === "true" || false;
   if (testMode) {
+    logger.debug("In test mode. Results are not uploaded.");
     return;
   }
 

diff --git a/upload-sarif/action.yml b/upload-sarif/action.yml
@@ -14,10 +14,10 @@ inputs:
     required: false
     default: ${{ github.workspace }}
   ref:
-    description: "The ref where results will be uploaded. If not provided, the Action will use the GITHUB_REF environment variable. If provided, the sha input must be provided as well."
+    description: "The ref where results will be uploaded. If not provided, the Action will use the GITHUB_REF environment variable. If provided, the sha input must be provided as well. This input is not available in pull requests from forks."
     required: false
   sha:
-    description: "The sha of the HEAD of the ref where results will be uploaded. If not provided, the Action will use the GITHUB_SHA environment variable. If provided, the ref input must be provided as well."
+    description: "The sha of the HEAD of the ref where results will be uploaded. If not provided, the Action will use the GITHUB_SHA environment variable. If provided, the ref input must be provided as well. This input is not available in pull requests from forks."
     required: false
   token:
     default: ${{ github.token }}