Add summary toggle option (#217)

Author: andre4ik3

README.md

@@ -132,6 +132,7 @@ Differing from the upstream [Nix](https://github.com/NixOS/nix) installer script
 | `reinstall`             | Force a reinstall if an existing installation is detected (consider backing up `/nix/store`)                                                                                                                                                                                   | Boolean                                    | `false`                                                        |
 | `start-daemon`          | If the daemon should be started, requires `planner: linux-multi`                                                                                                                                                                                                               | Boolean                                    | `false`                                                        |
 | `trust-runner-user`     | Whether to make the runner user trusted by the Nix daemon                                                                                                                                                                                                                      | Boolean                                    | `true`                                                         |
+| `summarize`             | Whether to add a build summary and timeline chart to the GitHub job summary                                                                                                                                                                                                    | Boolean                                    | `true`                                                         |
 | `diagnostic-endpoint`   | Diagnostic endpoint url where the installer sends install [diagnostic reports](https://github.com/DeterminateSystems/nix-installer#diagnostics) to, to disable set this to an empty string                                                                                     | string                                     | `https://install.determinate.systems/nix-installer/diagnostic` |
 | `proxy`                 | The proxy to use (if any), valid proxy bases are `https://$URL`, `http://$URL` and `socks5://$URL`                                                                                                                                                                             | string                                     |                                                                |
 | `ssl-cert-file`         | An SSL cert to use (if any), used for fetching Nix and sets `NIX_SSL_CERT_FILE` for Nix                                                                                                                                                                                        | string                                     |                                                                |

action.yml

@@ -126,6 +126,9 @@ inputs:
   trust-runner-user:
     description: Whether to make the runner user trusted by the Nix daemon
     default: true
+  summarize:
+    description: Whether to add a build summary and timeline chart to the GitHub job summary
+    default: true
   nix-installer-branch:
     description: (deprecated) The branch of `nix-installer` to use (conflicts with `nix-installer-tag`, `nix-installer-revision`, `nix-installer-pr`)
     required: false

dist/index.js

@@ -88,6 +88,7 @@ class NixInstallerAction extends DetSysAction {
   startDaemon: boolean;
   trustRunnerUser: boolean;
   runnerOs: string | undefined;
+  summarize: boolean;
 
   constructor() {
     if (platform.getArchOs() === "X64-macOS") {
@@ -152,6 +153,7 @@ class NixInstallerAction extends DetSysAction {
     this.reinstall = inputs.getBool("reinstall");
     this.startDaemon = inputs.getBool("start-daemon");
     this.trustRunnerUser = inputs.getBool("trust-runner-user");
+    this.summarize = inputs.getBool("summarize");
     this.runnerOs = process.env["RUNNER_OS"];
   }
 
@@ -164,12 +166,14 @@ class NixInstallerAction extends DetSysAction {
 
   async post(): Promise<void> {
     await this.annotateMismatches();
-    try {
-      await this.summarizeExecution();
-    } catch (err: unknown) {
-      this.recordEvent("summarize-execution:error", {
-        exception: stringifyError(err),
-      });
+    if (this.summarize) {
+      try {
+        await this.summarizeExecution();
+      } catch (err: unknown) {
+        this.recordEvent("summarize-execution:error", {
+          exception: stringifyError(err),
+        });
+      }
     }
     await this.cleanupNoSystemd();
     await this.reportOverall();