Add check that github-token always specified with always-comment. Sim…

…plify logic
MaxymVlasov · Feb 12, 2025 · 0dd24f4 · 0dd24f4
1 parent 8d36c05
commit 0dd24f4
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 37 deletions.
diff --git a/dist/index.js b/dist/index.js
@@ -101,6 +101,14 @@ function format(output) {
 function error(message) {
     core.setOutput('error', message);
     core.setFailed(message);
+    throw new Error(message);
+}
+function postComment(token, output) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const octokit = github.getOctokit(token);
+        const comment = Object.assign(Object.assign({}, github.context.issue), { issue_number: github.context.issue.number, body: format(output) });
+        yield octokit.rest.issues.createComment(comment);
+    });
 }
 /**
  * Executes a Docker image analysis using the dive tool and handles the results.
@@ -123,16 +131,19 @@ function run() {
             const image = core.getInput('image');
             if (!image) {
                 error('Missing required parameter: image');
-                return;
             }
             const configFile = core.getInput('config-file');
             // Convert always-comment input to boolean value.
             // All values other than 'true' are considered false.
             const alwaysComment = core.getInput('always-comment').toLowerCase() === 'true';
+            const token = core.getInput('github-token');
+            if (alwaysComment && !token) {
+                error('"always-comment" parameter requires "github-token" to be set.');
+            }
             const diveRepo = core.getInput('dive-image-registry');
             // Validate Docker image name format
             if (!/^[\w.\-_/]+$/.test(diveRepo)) {
-                throw new Error('Invalid dive-image-registry format');
+                error('Invalid dive-image-registry format');
             }
             const diveVersion = core.getInput('dive-image-version');
             const diveImage = `${diveRepo}:${diveVersion}`;
@@ -172,23 +183,21 @@ function run() {
                 }
             };
             const exitCode = yield exec.exec('docker', parameters, execOptions);
-            if (exitCode === 0 && !alwaysComment) {
-                // success
-                return;
-            }
-            const token = core.getInput('github-token');
-            if (!token) {
-                error(`Scan failed (exit code: ${exitCode}).\nTo post scan results ` +
-                    'as a PR comment, please provide the github-token in the action inputs.');
-                return;
+            const scanFailedErrorMsg = `Scan failed (exit code: ${exitCode})`;
+            if (alwaysComment) {
+                postComment(token, output);
+                if (exitCode === 0)
+                    return;
+                error(scanFailedErrorMsg);
             }
-            const octokit = github.getOctokit(token);
-            const comment = Object.assign(Object.assign({}, github.context.issue), { issue_number: github.context.issue.number, body: format(output) });
-            yield octokit.rest.issues.createComment(comment);
-            if (exitCode === 0 && alwaysComment) {
+            if (exitCode === 0)
                 return;
+            if (!token) {
+                error(`Scan failed (exit code: ${exitCode}).\nTo post scan results as ` +
+                    'a PR comment, please provide the github-token in the action inputs.');
             }
-            error(`Scan failed (exit code: ${exitCode})`);
+            postComment(token, output);
+            error(scanFailedErrorMsg);
         }
         catch (e) {
             error(e instanceof Error ? e.message : String(e));

diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/main.ts b/src/main.ts
@@ -47,6 +47,17 @@ function format(output: string): string {
 function error(message: string): void {
   core.setOutput('error', message)
   core.setFailed(message)
+  throw new Error(message)
+}
+
+async function postComment(token: string, output: string): Promise<void> {
+  const octokit = github.getOctokit(token)
+  const comment = {
+    ...github.context.issue,
+    issue_number: github.context.issue.number,
+    body: format(output)
+  }
+  await octokit.rest.issues.createComment(comment)
 }
 
 /**
@@ -69,18 +80,22 @@ async function run(): Promise<void> {
     const image = core.getInput('image')
     if (!image) {
       error('Missing required parameter: image')
-      return
     }
     const configFile = core.getInput('config-file')
     // Convert always-comment input to boolean value.
     // All values other than 'true' are considered false.
     const alwaysComment =
       core.getInput('always-comment').toLowerCase() === 'true'
+    const token = core.getInput('github-token')
+
+    if (alwaysComment && !token) {
+      error('"always-comment" parameter requires "github-token" to be set.')
+    }
 
     const diveRepo = core.getInput('dive-image-registry')
     // Validate Docker image name format
     if (!/^[\w.\-_/]+$/.test(diveRepo)) {
-      throw new Error('Invalid dive-image-registry format')
+      error('Invalid dive-image-registry format')
     }
     const diveVersion = core.getInput('dive-image-version')
     const diveImage = `${diveRepo}:${diveVersion}`
@@ -129,32 +144,29 @@ async function run(): Promise<void> {
       }
     }
     const exitCode = await exec.exec('docker', parameters, execOptions)
-    if (exitCode === 0 && !alwaysComment) {
-      // success
-      return
+
+    const scanFailedErrorMsg = `Scan failed (exit code: ${exitCode})`
+
+    if (alwaysComment) {
+      postComment(token, output)
+
+      if (exitCode === 0) return
+
+      error(scanFailedErrorMsg)
     }
 
-    const token = core.getInput('github-token')
+    if (exitCode === 0) return
+
     if (!token) {
       error(
-        `Scan failed (exit code: ${exitCode}).\nTo post scan results ` +
-          'as a PR comment, please provide the github-token in the action inputs.'
+        `Scan failed (exit code: ${exitCode}).\nTo post scan results as ` +
+          'a PR comment, please provide the github-token in the action inputs.'
       )
-      return
-    }
-    const octokit = github.getOctokit(token)
-    const comment = {
-      ...github.context.issue,
-      issue_number: github.context.issue.number,
-      body: format(output)
     }
-    await octokit.rest.issues.createComment(comment)
 
-    if (exitCode === 0 && alwaysComment) {
-      return
-    }
+    postComment(token, output)
 
-    error(`Scan failed (exit code: ${exitCode})`)
+    error(scanFailedErrorMsg)
   } catch (e) {
     error(e instanceof Error ? e.message : String(e))
   }