restore.ts - update-package-index option (#386)

add update-package-index option

Author: Andrej730

.github/workflows/tests.yml

@@ -263,3 +263,27 @@ jobs:
         uses: ./
         with:
           evict-old-files: ${{ matrix.evict }}
+
+  test_option_update:
+    runs-on: ubuntu-latest
+    container: ubuntu:latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Run ccache-action
+        uses: ./
+        with:
+          update-package-index: true
+
+  test_option_update_breaks:
+    # Needed to ensure `test_option_update` actually does something.
+    runs-on: ubuntu-latest
+    container: ubuntu:latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Run ccache-action
+        id: ccache
+        uses: ./
+        continue-on-error: true
+      - name: Fail if previous step succeeded without update
+        if: steps.ccache.outcome == 'success'
+        run: exit 1

action.yml

@@ -41,6 +41,11 @@ inputs:
       followed by the 's' or 'd' suffix respectively. Also supports the special value 'job' which represents the time
       since the job started, which evicts all cache files that were not touched during the job run."
     default: ''
+  update-package-index:
+    description: "Update package manager index before installing ccache. Enabling this might help when running
+      ccache-action in a container or from `act`. Disabling this might speed up the action execution."
+    default: false
+    required: false
 runs:
   using: "node20"
   main: "dist/restore/index.js"

dist/restore/index.js

@@ -66428,6 +66428,11 @@ function cacheDir(ccacheVariant) {
 
 
 const SELF_CI = external_process_namespaceObject.env["CCACHE_ACTION_CI"] === "true";
+function getPackageManagerError(error) {
+    return (`Failed to install ccache via package manager: '${error}'. ` +
+        "Perhaps package manager index is not up to date? " +
+        "(either update it manually before running ccache-action or set 'update-package-index' option to 'true')");
+}
 // based on https://cristianadam.eu/20200113/speeding-up-c-plus-plus-github-actions-using-ccache/
 async function restore(ccacheVariant) {
     const inputs = {
@@ -66490,22 +66495,45 @@ async function configure(ccacheVariant, platform) {
     }
 }
 async function installCcacheMac() {
-    await execShell("brew install ccache");
+    if (lib_core.getBooleanInput("update-package-index")) {
+        await execShell("brew update");
+    }
+    try {
+        await execShell("brew install ccache");
+    }
+    catch (error) {
+        throw new Error(getPackageManagerError(error));
+    }
 }
 async function installCcacheLinux() {
-    if (await io.which("apt-get")) {
-        await execShellSudo("apt-get install -y ccache");
-        return;
-    }
-    else if (await io.which("apk")) {
-        await execShell("apk add ccache");
-        return;
+    const shouldUpdate = lib_core.getBooleanInput("update-package-index");
+    try {
+        if (await io.which("apt-get")) {
+            if (shouldUpdate) {
+                await execShellSudo("apt-get update");
+            }
+            await execShellSudo("apt-get install -y ccache");
+            return;
+        }
+        else if (await io.which("apk")) {
+            if (shouldUpdate) {
+                await execShell("apk update");
+            }
+            await execShell("apk add ccache");
+            return;
+        }
+        else if (await io.which("dnf")) {
+            if (shouldUpdate) {
+                await execShell("dnf check-update");
+            }
+            // ccache is part of EPEL repo.
+            await execShell("dnf install -y epel-release");
+            await execShell("dnf install -y ccache");
+            return;
+        }
     }
-    else if (await io.which("dnf")) {
-        // ccache is part of EPEL repo.
-        await execShell("dnf install -y epel-release");
-        await execShell("dnf install -y ccache");
-        return;
+    catch (error) {
+        throw new Error(getPackageManagerError(error));
     }
     throw Error("Can't install ccache automatically under this platform, please install it yourself before using this action.");
 }

src/restore.ts

@@ -11,6 +11,14 @@ import { cacheDir } from "./common";
 
 const SELF_CI = process.env["CCACHE_ACTION_CI"] === "true"
 
+function getPackageManagerError(error: Error | unknown) : string {
+  return (
+    `Failed to install ccache via package manager: '${error}'. ` +
+    "Perhaps package manager index is not up to date? " +
+    "(either update it manually before running ccache-action or set 'update-package-index' option to 'true')"
+  );
+}
+
 // based on https://cristianadam.eu/20200113/speeding-up-c-plus-plus-github-actions-using-ccache/
 
 async function restore(ccacheVariant : string) : Promise<void> {
@@ -79,22 +87,44 @@ async function configure(ccacheVariant : string, platform : string) : Promise<vo
 }
 
 async function installCcacheMac() : Promise<void> {
-  await execShell("brew install ccache");
+  if (core.getBooleanInput("update-package-index")) {
+    await execShell("brew update");
+  }
+  try {
+    await execShell("brew install ccache");
+  } catch (error) {
+    throw new Error(getPackageManagerError(error));
+  }
 }
 
 async function installCcacheLinux() : Promise<void> {
-  if (await io.which("apt-get")) {
-    await execShellSudo("apt-get install -y ccache");
-    return;
-  } else if (await io.which("apk")) {
-    await execShell("apk add ccache");
-    return;
-  } else if (await io.which("dnf")) {
-    // ccache is part of EPEL repo.
-    await execShell("dnf install -y epel-release");
-    await execShell("dnf install -y ccache");
-    return;
+  const shouldUpdate = core.getBooleanInput("update-package-index");
+  try {
+    if (await io.which("apt-get")) {
+      if (shouldUpdate) {
+        await execShellSudo("apt-get update");
+      }
+      await execShellSudo("apt-get install -y ccache");
+      return;
+    } else if (await io.which("apk")) {
+      if (shouldUpdate) {
+        await execShell("apk update");
+      }
+      await execShell("apk add ccache");
+      return;
+    } else if (await io.which("dnf")) {
+      if (shouldUpdate) {
+        await execShell("dnf check-update");
+      }
+      // ccache is part of EPEL repo.
+      await execShell("dnf install -y epel-release");
+      await execShell("dnf install -y ccache");
+      return;
+    }
+  } catch (error) {
+    throw new Error(getPackageManagerError(error));
   }
+
   throw Error("Can't install ccache automatically under this platform, please install it yourself before using this action.");
 }