github - use GHA workflow commands to group logs

Author: cscheid

package/src/bld.ts

@@ -61,57 +61,47 @@ function getCommands() {
   // deno-lint-ignore no-explicit-any
   const commands: Command<any>[] = [];
   commands.push(
-    packageCommand(configure)
-      .name("configure")
+    packageCommand(configure, "configure")
       .description(
         "Configures this machine for running developer version of Quarto",
       ),
   );
   commands.push(
-    packageCommand(updateHtmlDependencies)
-      .name("update-html-dependencies")
+    packageCommand(updateHtmlDependencies, "update-html-dependencies")
       .description(
         "Updates Bootstrap, themes, and JS/CSS dependencies based upon the version in configuration",
       ),
   );
   commands.push(
-    packageCommand(archiveBinaryDependencies)
-      .name("archive-bin-deps")
+    packageCommand(archiveBinaryDependencies, "archive-bin-deps")
       .description("Downloads and archives our binary dependencies."),
   );
   commands.push(
-    packageCommand(checkBinaryDependencies)
-      .name("check-bin-deps")
+    packageCommand(checkBinaryDependencies, "check-bin-deps")
       .description("Checks the paths and URLs of our binary dependencies."),
   );
   commands.push(
-    packageCommand(prepareDist)
-      .name("prepare-dist")
+    packageCommand(prepareDist, "prepare-dist")
       .description("Prepares the distribution directory for packaging."),
   );
   commands.push(
-    packageCommand(validateBundle)
-      .name("validate-bundle")
+    packageCommand(validateBundle, "validate-bundle")
       .description("Validate a JS bundle built using prepare-dist")
   );
   commands.push(
-    packageCommand(makeInstallerMac)
-      .name("make-installer-mac")
+    packageCommand(makeInstallerMac, "make-installer-mac")
       .description("Builds Mac OS installer"),
   );
   commands.push(
-    packageCommand(makeInstallerDeb)
-      .name("make-installer-deb")
+    packageCommand(makeInstallerDeb, "make-installer-deb")
       .description("Builds Linux deb installer"),
   );
   commands.push(
-    packageCommand(makeInstallerWindows)
-      .name("make-installer-win")
+    packageCommand(makeInstallerWindows, "make-installer-win")
       .description("Builds Windows installer"),
   );
   commands.push(
-    packageCommand(makeInstallerExternal)
-      .name("make-installer-dir")
+    packageCommand(makeInstallerExternal, "make-installer-dir")
       .description("Copies Quarto-only files, omitting dependencies, to specified location (for use in third party packaging)"),
   );
   commands.push(

package/src/cmd/pkg-cmd.ts

@@ -7,6 +7,8 @@
 import { Command } from "cliffy/command/mod.ts";
 import { join } from "../../../src/deno_ral/path.ts";
 
+import { group } from "../../../src/tools/github.ts";
+
 import { printConfiguration } from "../common/config.ts";
 
 import {
@@ -19,7 +21,7 @@ import {
 export const kLogLevel = "logLevel";
 export const kVersion = "setVersion";
 
-export function packageCommand(run: (config: Configuration) => Promise<void>) {
+export function packageCommand(run: (config: Configuration) => Promise<void>, commandName: string) {
   return new Command().option(
     "-sv, --set-version [version:string]",
     "Version to set when preparing this distribution",
@@ -51,7 +53,9 @@ export function packageCommand(run: (config: Configuration) => Promise<void>) {
       // Print the configuration
       printConfiguration(config);
 
-      // Run the command
-      await run(config);
-    });
+      await group(commandName, async () => {
+        // Run the command
+        await run(config);
+      });
+    }).name(commandName);
 }

src/import_map.json

@@ -6,6 +6,7 @@
     "encoding/": "jsr:/@std/encoding@1.0.9/",
     "fmt/": "jsr:/@std/fmt@1.0.6/",
     "fs/": "jsr:/@std/fs@1.0.16/",
+    "github_actions/core": "npm:@actions/core@1.11.1",
     "http/": "jsr:/@std/http@1.0.14/",
     "path": "jsr:@std/path@1.0.8",
     "path/posix": "jsr:@std/path@1.0.8/posix",

src/tools/github.ts

@@ -1,11 +1,11 @@
 /*
-* github.ts
-*
-* Copyright (C) 2020-2022 Posit Software, PBC
-*
-*/
+ * github.ts
+ *
+ * Copyright (C) 2020-2022 Posit Software, PBC
+ */
 
 import { GitHubRelease } from "./types.ts";
+import * as core from "github_actions/core";
 
 // deno-lint-ignore-file camelcase
 
@@ -26,3 +26,11 @@ export async function getLatestRelease(repo: string): Promise<GitHubRelease> {
     return response.json();
   }
 }
+
+export async function group<T>(title: string, fn: () => Promise<T>) {
+  Deno.env.get("CI");
+  if (!Deno.env.get("CI")) {
+    return fn();
+  }
+  return core.group(title, fn);
+}