Add a new flag create-symlink (#172)

.github/workflows/tests.yml

@@ -210,3 +210,23 @@ jobs:
         uses: ./
         with:
           append-timestamp: ${{ matrix.append-timestamp }}
+
+  test_option_create_symlink:
+    # Test that the 'create-symlink' option is available.
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        create-symlink: [true, false]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run ccache-action
+        uses: ./
+        with:
+          create-symlink: ${{ matrix.create-symlink }}
+      - name: Test symlink
+        run: |
+          if [ ${{ matrix.create-symlink }} = true ]; then
+            ls -l $(which gcc) | grep $(which ccache)
+          else
+            ls -l $(which gcc) | grep -v $(which ccache)
+          fi

README.md

@@ -35,6 +35,16 @@ or by manipulating `PATH` (ccache only):
 
 (works for both `ubuntu` and `macos`)
 
+or by setting create-symlink to `true`:
+
+```yaml
+- name: ccache
+  uses: hendrikmuhs/[email protected]
+  with:
+    create-symlink: true
+```
+
+
 Ccache/sccache gets installed by this action if it is not installed yet.
 
 ### Example workflow

action.yml

@@ -28,6 +28,10 @@ inputs:
     description: "Append a timestamp to the cache key (default: true)"
     default: true
     required: false
+  create-symlink:
+    description: "If set to 'true', create symlinks for ccache in /usr/local/bin to override default toolchains"
+    default: false
+    required: false
 runs:
   using: "node16"
   main: "dist/restore/index.js"

dist/restore/index.js

@@ -59626,6 +59626,15 @@ async function configure(ccacheVariant, platform) {
         if (platform === "darwin") {
             await execBash(`ccache --set-config=compiler_check=content`);
         }
+        if (core.getBooleanInput("create-symlink")) {
+            const ccache = await io.which("ccache");
+            await execBash(`ln -s ${ccache} /usr/local/bin/gcc`);
+            await execBash(`ln -s ${ccache} /usr/local/bin/g++`);
+            await execBash(`ln -s ${ccache} /usr/local/bin/cc`);
+            await execBash(`ln -s ${ccache} /usr/local/bin/c++`);
+            await execBash(`ln -s ${ccache} /usr/local/bin/clang`);
+            await execBash(`ln -s ${ccache} /usr/local/bin/clang++`);
+        }
         core.info("Cccache config:");
         await execBash("ccache -p");
     }

src/restore.ts

@@ -56,6 +56,15 @@ async function configure(ccacheVariant : string, platform : string) : Promise<vo
     if (platform === "darwin") {
       await execBash(`ccache --set-config=compiler_check=content`);
     }
+    if (core.getBooleanInput("create-symlink")) {
+      const ccache = await io.which("ccache");
+      await execBash(`ln -s ${ccache} /usr/local/bin/gcc`);
+      await execBash(`ln -s ${ccache} /usr/local/bin/g++`);
+      await execBash(`ln -s ${ccache} /usr/local/bin/cc`);
+      await execBash(`ln -s ${ccache} /usr/local/bin/c++`);
+      await execBash(`ln -s ${ccache} /usr/local/bin/clang`);
+      await execBash(`ln -s ${ccache} /usr/local/bin/clang++`);
+    }
     core.info("Cccache config:");
     await execBash("ccache -p");
   } else {