feat: allow skipping job summary when no blocks or failures are present

Co-authored-by: Allan Reyes <allanbreyes@users.noreply.github.com>

Author: ahmadnassri

README.md

@@ -43,12 +43,12 @@ jobs:
 
 #### Inputs
 
-| Input              | Description                                           | Required | Default              |
-| ------------------ | ----------------------------------------------------- | -------- | -------------------- |
-| `firewall-version` | Specify the firewall version number                   | No       | `latest`             |
-| `job-summary`      | Create a [job summary][job-summary]                   | No       | `true`               |
-| `use-cache`        | Cache the Socket binaries (force download if `false`) | No       | `true`               |
-| `github-token`     | GitHub API Token used for downloading binaries        | No       | `${{ github.token}}` |
+| Input              | Description                                                      | Required | Default              |
+| ------------------ | ---------------------------------------------------------------- | -------- | -------------------- |
+| `firewall-version` | Specify the firewall version number                              | No       | `latest`             |
+| `job-summary`      | Create a [job summary][job-summary] (`all`, `errors`, or `none`) | No       | `all`                |
+| `use-cache`        | Cache the Socket binaries (force download if `false`)            | No       | `true`               |
+| `github-token`     | GitHub API Token used for downloading binaries                   | No       | `${{ github.token}}` |
 
 #### Outputs
 
@@ -88,13 +88,13 @@ jobs:
 
 #### Inputs
 
-| Input              | Description                                           | Required | Default              |
-| ------------------ | ----------------------------------------------------- | -------- | -------------------- |
-| `firewall-version` | Specify the firewall version number                   | No       | `latest`             |
-| `job-summary`      | Create a [job summary][job-summary]                   | No       | `true`               |
-| `use-cache`        | Cache the Socket binaries (force download if `false`) | No       | `true`               |
-| `github-token`     | GitHub API Token used for downloading binaries        | No       | `${{ github.token}}` |
-| `socket-token`     | Socket API Token                                      | **YES**  | `-`                  |
+| Input              | Description                                                      | Required | Default              |
+| ------------------ | ---------------------------------------------------------------- | -------- | -------------------- |
+| `firewall-version` | Specify the firewall version number                              | No       | `latest`             |
+| `job-summary`      | Create a [job summary][job-summary] (`all`, `errors`, or `none`) | No       | `all`                |
+| `use-cache`        | Cache the Socket binaries (force download if `false`)            | No       | `true`               |
+| `github-token`     | GitHub API Token used for downloading binaries                   | No       | `${{ github.token}}` |
+| `socket-token`     | Socket API Token                                                 | **YES**  | `-`                  |
 
 #### Outputs
 
@@ -104,4 +104,3 @@ jobs:
 | `firewall-path-binary` | Path to the installed binary               |
 
 [job-summary]: https://github.blog/news-insights/product-news/supercharging-github-actions-with-job-summaries
-[job-summary]: https://github.blog/news-insights/product-news/supercharging-github-actions-with-job-summaries

action.yml

@@ -27,7 +27,7 @@ inputs:
 
   job-summary:
     description: Create a job summary
-    default: 'true'
+    default: all
 
   firewall-version:
     description: Specify the firewall version number

src/main.js

@@ -22,9 +22,13 @@ const inputs = {
   tokenSocket: core.getInput('socket-token'),
   versionFirewall: core.getInput('firewall-version'),
   useCache: core.getBooleanInput('use-cache'),
-  jobSummary: core.getBooleanInput('job-summary')
+  jobSummary: core.getInput('job-summary', { required: false }).toLowerCase()
 }
 
+// backward compatibility
+if (inputs.jobSummary === 'true') inputs.jobSummary = 'all'
+if (inputs.jobSummary === 'false') inputs.jobSummary = 'none'
+
 if (inputs.tokenSocket) {
   // setup socket token as a secret env
   core.exportVariable('SOCKET_API_KEY', inputs.tokenSocket)

src/post.js

@@ -3,13 +3,21 @@ import { readFile } from 'node:fs/promises'
 import { PackageURL } from 'packageurl-js'
 
 // should show job summary?
-const jobSummary = core.getBooleanInput('job-summary', { required: false })
+const inputs = {
+  jobSummary: core.getInput('job-summary', { required: false }).toLowerCase()
+}
+
+// backward compatibility
+if (inputs.jobSummary === 'true') inputs.jobSummary = 'all'
+if (inputs.jobSummary === 'false') inputs.jobSummary = 'none'
 
-if (!jobSummary) {
+// exit early
+if (inputs.jobSummary === 'none') {
   core.info('skipping firewall job summary')
   process.exit(0)
 }
 
+// failed in setup
 if (!process.env.SFW_JSON_REPORT_PATH) {
   core.info('firewall report path not set')
   process.exit(0)
@@ -35,6 +43,11 @@ try {
 await core.summary.addRaw('<h2>Socket Firewall Report</h2>')
 
 if (!report.blocked && !report.parseFail) {
+  if (inputs.jobSummary === 'errors') {
+    core.info('no errors detected, skipping job summary')
+    process.exit(0)
+  }
+
   core.summary.addRaw('Nothing to report :tada:', true)
 }
 

src/tools/firewall.js

@@ -111,7 +111,7 @@ export default async function download ({ edition = 'free', ...inputs }) {
   core.debug(`binary location: ${pathCache}`)
 
   // set report path env
-  if (inputs.jobSummary) {
+  if (inputs.jobSummary !== 'none') {
     const pathReport = `${path.join(process.env.RUNNER_TEMP, randomUUID())}.json`
     // set the env info to be used in "post.js" step
     core.exportVariable('SFW_JSON_REPORT_PATH', pathReport)