Use core.group instead for more strict grouping

Signed-off-by: Sora Morimoto <[email protected]>
ocaml · Nov 4, 2023 · 6e9652e · 6e9652e
1 parent 01a0d3d
commit 6e9652e
Show file tree

Hide file tree

Showing 13 changed files with 1,280 additions and 1,040 deletions.
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/post/index.js b/dist/post/index.js
diff --git a/lint-doc/dist/index.js b/lint-doc/dist/index.js
diff --git a/lint-fmt/dist/index.js b/lint-fmt/dist/index.js
diff --git a/lint-opam/dist/index.js b/lint-opam/dist/index.js
diff --git a/packages/lint-doc/src/opam.ts b/packages/lint-doc/src/opam.ts
@@ -2,13 +2,19 @@ import * as core from "@actions/core";
 import { exec } from "@actions/exec";
 
 export async function installOpamPackages() {
-  core.startGroup("Install opam packages");
-  await exec("opam", ["install", ".", "--deps-only", "--with-doc"]);
-  core.endGroup();
+  await core.group("Install opam packages", async () => {
+    await exec("opam", ["install", ".", "--deps-only", "--with-doc"]);
+  });
 }
 
 export async function installOdoc() {
-  core.startGroup("Install odoc");
-  await exec("opam", ["depext", "--install", "conf-m4", "dune", "odoc>=1.5.0"]);
-  core.endGroup();
+  await core.group("Install odoc", async () => {
+    await exec("opam", [
+      "depext",
+      "--install",
+      "conf-m4",
+      "dune",
+      "odoc>=1.5.0",
+    ]);
+  });
 }
diff --git a/packages/lint-fmt/src/opam.ts b/packages/lint-fmt/src/opam.ts
@@ -2,7 +2,7 @@ import * as core from "@actions/core";
 import { exec } from "@actions/exec";
 
 export async function installOcamlformat(version: string) {
-  core.startGroup("Install ocamlformat");
-  await exec("opam", ["depext", "--install", `ocamlformat=${version}`]);
-  core.endGroup();
+  await core.group("Install ocamlformat", async () => {
+    await exec("opam", ["depext", "--install", `ocamlformat=${version}`]);
+  });
 }
diff --git a/packages/lint-opam/src/opam.ts b/packages/lint-opam/src/opam.ts
@@ -2,19 +2,19 @@ import * as core from "@actions/core";
 import { exec } from "@actions/exec";
 
 export async function installOpamPackages() {
-  core.startGroup("Install opam packages");
-  await exec("opam", [
-    "install",
-    ".",
-    "--deps-only",
-    "--with-test",
-    "--with-doc",
-  ]);
-  core.endGroup();
+  await core.group("Install opam packages", async () => {
+    await exec("opam", [
+      "install",
+      ".",
+      "--deps-only",
+      "--with-test",
+      "--with-doc",
+    ]);
+  });
 }
 
 export async function installOpamDuneLint() {
-  core.startGroup("Install opam-dune-lint");
-  await exec("opam", ["depext", "--install", "opam-dune-lint"]);
-  core.endGroup();
+  await core.group("Install opam-dune-lint", async () => {
+    await exec("opam", ["depext", "--install", "opam-dune-lint"]);
+  });
 }
diff --git a/packages/setup-ocaml/src/cache.ts b/packages/setup-ocaml/src/cache.ts
@@ -220,75 +220,75 @@ async function saveCache(key: string, paths: string[]) {
 }
 
 export async function restoreCygwinCache() {
-  core.startGroup("Retrieve the Cygwin cache");
-  const { key, restoreKeys } = await composeCygwinCacheKeys();
-  const paths = composeCygwinCachePaths();
-  await restoreCache(key, restoreKeys, paths);
-  core.endGroup();
+  await core.group("Retrieve the Cygwin cache", async () => {
+    const { key, restoreKeys } = await composeCygwinCacheKeys();
+    const paths = composeCygwinCachePaths();
+    await restoreCache(key, restoreKeys, paths);
+  });
 }
 
 export async function saveCygwinCache() {
-  core.startGroup("Save the Cygwin cache");
-  const { key } = await composeCygwinCacheKeys();
-  const paths = composeCygwinCachePaths();
-  await saveCache(key, paths);
-  core.endGroup();
+  await core.group("Save the Cygwin cache", async () => {
+    const { key } = await composeCygwinCacheKeys();
+    const paths = composeCygwinCachePaths();
+    await saveCache(key, paths);
+  });
 }
 
 export async function restoreDuneCache() {
-  core.startGroup("Retrieve the dune cache");
-  const { key, restoreKeys } = composeDuneCacheKeys();
-  const paths = composeDuneCachePaths();
-  await restoreCache(key, restoreKeys, paths);
-  core.endGroup();
+  await core.group("Retrieve the dune cache", async () => {
+    const { key, restoreKeys } = composeDuneCacheKeys();
+    const paths = composeDuneCachePaths();
+    await restoreCache(key, restoreKeys, paths);
+  });
 }
 
 export async function saveDuneCache() {
-  core.startGroup("Save the dune cache");
-  const { key } = composeDuneCacheKeys();
-  const paths = composeDuneCachePaths();
-  await saveCache(key, paths);
-  core.endGroup();
+  await core.group("Save the dune cache", async () => {
+    const { key } = composeDuneCacheKeys();
+    const paths = composeDuneCachePaths();
+    await saveCache(key, paths);
+  });
 }
 
 export async function restoreOpamCache() {
-  core.startGroup("Retrieve the opam cache");
-  const { key, restoreKeys } = await composeOpamCacheKeys();
-  const paths = composeOpamCachePaths();
-  const cacheKey = await restoreCache(key, restoreKeys, paths);
-  core.endGroup();
-  return cacheKey;
+  return await core.group("Retrieve the opam cache", async () => {
+    const { key, restoreKeys } = await composeOpamCacheKeys();
+    const paths = composeOpamCachePaths();
+    const cacheKey = await restoreCache(key, restoreKeys, paths);
+    return cacheKey;
+  });
 }
 
 export async function saveOpamCache() {
-  core.startGroup("Save the opam cache");
-  await exec("opam", [
-    "clean",
-    "--all-switches",
-    "--download-cache",
-    "--logs",
-    "--repo-cache",
-    "--unused-repositories",
-  ]);
-  const { key } = await composeOpamCacheKeys();
-  const paths = composeOpamCachePaths();
-  await saveCache(key, paths);
-  core.endGroup();
+  await core.group("Save the opam cache", async () => {
+    await exec("opam", [
+      "clean",
+      "--all-switches",
+      "--download-cache",
+      "--logs",
+      "--repo-cache",
+      "--unused-repositories",
+    ]);
+    const { key } = await composeOpamCacheKeys();
+    const paths = composeOpamCachePaths();
+    await saveCache(key, paths);
+  });
 }
 
 export async function restoreOpamDownloadCache() {
-  core.startGroup("Retrieve the opam download cache");
-  const { key, restoreKeys } = composeOpamDownloadCacheKeys();
-  const paths = composeOpamDownloadCachePaths();
-  const cacheKey = await restoreCache(key, restoreKeys, paths);
-  core.endGroup();
-  return cacheKey;
+  return await core.group("Retrieve the opam download cache", async () => {
+    const { key, restoreKeys } = composeOpamDownloadCacheKeys();
+    const paths = composeOpamDownloadCachePaths();
+    const cacheKey = await restoreCache(key, restoreKeys, paths);
+    return cacheKey;
+  });
 }
 
 export async function saveOpamDownloadCache() {
-  core.startGroup("Save the opam download cache");
-  const { key } = composeOpamDownloadCacheKeys();
-  const paths = composeOpamDownloadCachePaths();
-  await saveCache(key, paths);
-  core.endGroup();
+  await core.group("Save the opam download cache", async () => {
+    const { key } = composeOpamDownloadCacheKeys();
+    const paths = composeOpamDownloadCachePaths();
+    await saveCache(key, paths);
+  });
 }
diff --git a/packages/setup-ocaml/src/depext.ts b/packages/setup-ocaml/src/depext.ts
@@ -7,26 +7,31 @@ import { OPAM_DEPEXT_FLAGS, Platform } from "./constants";
 import { getPlatform } from "./system";
 
 export async function installDepext(ocamlVersion: string) {
-  core.startGroup("Install depext");
-  const platform = getPlatform();
-  const depextCygwinports =
-    platform === Platform.Win32 ? ["depext-cygwinports"] : [];
-  await exec("opam", ["install", "opam-depext", ...depextCygwinports]);
-  if (platform === Platform.Win32) {
-    let base = "";
-    if (ocamlVersion.includes("mingw64")) {
-      base = "x86_64-w64-mingw32";
-    } else if (ocamlVersion.includes("mingw32")) {
-      base = "i686-w64-mingw32";
+  await core.group("Install depext", async () => {
+    const platform = getPlatform();
+    const depextCygwinports =
+      platform === Platform.Win32 ? ["depext-cygwinports"] : [];
+    await exec("opam", ["install", "opam-depext", ...depextCygwinports]);
+    if (platform === Platform.Win32) {
+      let base = "";
+      if (ocamlVersion.includes("mingw64")) {
+        base = "x86_64-w64-mingw32";
+      } else if (ocamlVersion.includes("mingw32")) {
+        base = "i686-w64-mingw32";
+      }
+      core.addPath(
+        path.posix.join("/", "usr", base, "sys-root", "mingw", "bin"),
+      );
     }
-    core.addPath(path.posix.join("/", "usr", base, "sys-root", "mingw", "bin"));
-  }
-  core.endGroup();
+  });
 }
 
 export async function installDepextPackages(fpaths: string[]) {
-  core.startGroup("Install system packages required by opam packages");
-  const fnames = fpaths.map((fpath) => path.basename(fpath, ".opam"));
-  await exec("opam", ["depext", ...fnames, ...OPAM_DEPEXT_FLAGS]);
-  core.endGroup();
+  await core.group(
+    "Install system packages required by opam packages",
+    async () => {
+      const fnames = fpaths.map((fpath) => path.basename(fpath, ".opam"));
+      await exec("opam", ["depext", ...fnames, ...OPAM_DEPEXT_FLAGS]);
+    },
+  );
 }
diff --git a/packages/setup-ocaml/src/dune.ts b/packages/setup-ocaml/src/dune.ts
@@ -10,30 +10,33 @@ const {
 } = github.context;
 
 export async function installDune() {
-  core.startGroup("Install dune");
-  await exec("opam", ["depext", "--install", "dune"]);
-  core.endGroup();
+  await core.group("Install dune", async () => {
+    await exec("opam", ["depext", "--install", "dune"]);
+  });
 }
 
 export async function trimDuneCache() {
-  core.startGroup("Remove oldest files from the dune cache to free space");
-  const octokit = github.getOctokit(GITHUB_TOKEN);
-  const {
-    data: { total_count: totalCount },
-  } = await octokit.rest.actions.listJobsForWorkflowRun({
-    owner,
-    repo,
-    run_id,
-  });
-  const cacheSize = Math.floor(5000 / totalCount);
-  await exec("opam", [
-    "exec",
-    "--",
-    "dune",
-    "cache",
-    "trim",
-    "--size",
-    `${cacheSize}MB`,
-  ]);
-  core.endGroup();
+  await core.group(
+    "Remove oldest files from the dune cache to free space",
+    async () => {
+      const octokit = github.getOctokit(GITHUB_TOKEN);
+      const {
+        data: { total_count: totalCount },
+      } = await octokit.rest.actions.listJobsForWorkflowRun({
+        owner,
+        repo,
+        run_id,
+      });
+      const cacheSize = Math.floor(5000 / totalCount);
+      await exec("opam", [
+        "exec",
+        "--",
+        "dune",
+        "cache",
+        "trim",
+        "--size",
+        `${cacheSize}MB`,
+      ]);
+    },
+  );
 }
diff --git a/packages/setup-ocaml/src/installer.ts b/packages/setup-ocaml/src/installer.ts
@@ -54,18 +54,18 @@ export async function installer() {
     core.exportVariable("OPAMROOT", opamRoot);
   }
   if (platform === Platform.Win32) {
-    core.startGroup("Change the file system behavior parameters");
-    await exec("fsutil", ["behavior", "query", "SymlinkEvaluation"]);
-    // https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/fsutil-behavior
-    await exec("fsutil", [
-      "behavior",
-      "set",
-      "symlinkEvaluation",
-      "R2L:1",
-      "R2R:1",
-    ]);
-    await exec("fsutil", ["behavior", "query", "SymlinkEvaluation"]);
-    core.endGroup();
+    await core.group("Change the file system behavior parameters", async () => {
+      await exec("fsutil", ["behavior", "query", "SymlinkEvaluation"]);
+      // https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/fsutil-behavior
+      await exec("fsutil", [
+        "behavior",
+        "set",
+        "symlinkEvaluation",
+        "R2L:1",
+        "R2R:1",
+      ]);
+      await exec("fsutil", ["behavior", "query", "SymlinkEvaluation"]);
+    });
   }
   if (platform === Platform.Win32) {
     core.exportVariable("HOME", process.env["USERPROFILE"]);