From 878985d084d4991346a5f6f26eae447ddc16457a Mon Sep 17 00:00:00 2001 From: Kyle Mayes Date: Mon, 9 Oct 2023 21:21:42 -0400 Subject: [PATCH] Recommend against caching --- README.md | 22 ++-------------------- 1 file changed, 2 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index ecc2dd5..4085dd6 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,8 @@ For a given LLVM and Clang version, there are sometimes multiple binaries availa Whether the LLVM and Clang binaries were cached. +**Note:** Caching is not currently recommended, it is usually slower than just directly downloading the LLVM and Clang binaries. + ### `download-url` The URL to download LLVM and Clang binaries from. @@ -85,26 +87,6 @@ This will only differ from the value of the `version` option when specifying a m directory: ${{ runner.temp }}/llvm ``` -## Example Usage (with caching) - -```yml -- name: Cache LLVM and Clang - id: cache-llvm - uses: actions/cache@v3 - with: - path: | - C:/Program Files/LLVM - ./llvm - key: llvm-3.5 -- name: Install LLVM and Clang - uses: KyleMayes/install-llvm-action@v1 - with: - version: "3.5" - cached: ${{ steps.cache-llvm.outputs.cache-hit }} -``` - -**Note:** Based on some benchmarks on a GitHub Actions Ubuntu runner, an uncached install of the LLVM and Clang binaries using this action takes about 60 seconds but a cached install takes only about 20 seconds. - ## Linking to Installed Libraries (Linux) If your build system requires a library from the installed LLVM and Clang binaries such as `libclang.so`, and it fails to find it, then it may help to create a symlink for the versioned `.so` using the following step which utilizes the `LLVM_PATH` environment variable set by this action: