CI: Cache for GitHub Actions

Use caches for `ccache` on GitHub actions.

Author: ax3l

.github/workflows/cuda.yml

@@ -25,6 +25,19 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: install dependencies
+      run: |
+        .github/workflows/dependencies/nvcc11.sh
+    - name: CCache Cache
+      uses: actions/cache@v2
+      # - once stored under a key, they become immutable (even if local cache path content changes)
+      # - for a refresh the key has to change, e.g., hash of a tracked file in the key
+      with:
+        path: ~/.ccache
+        key: ccache-cuda-nvcc-${{ hashFiles('.github/workflows/cuda.yml') }}-${{ hashFiles('cmake/dependencies/AMReX.cmake') }}
+        restore-keys: |
+          ccache-cuda-nvcc-${{ hashFiles('.github/workflows/cuda.yml') }}-
+          ccache-cuda-nvcc-
+    - name: install openPMD-api
       run: |
         .github/workflows/dependencies/nvcc11.sh
         export CEI_SUDO="sudo"
@@ -96,6 +109,16 @@ jobs:
     - uses: actions/checkout@v2
     - name: Dependencies
       run: .github/workflows/dependencies/nvhpc.sh
+    - name: CCache Cache
+      uses: actions/cache@v2
+      # - once stored under a key, they become immutable (even if local cache path content changes)
+      # - for a refresh the key has to change, e.g., hash of a tracked file in the key
+      with:
+        path: ~/.ccache
+        key: ccache-cuda-nvhpc-${{ hashFiles('.github/workflows/cuda.yml') }}-${{ hashFiles('cmake/dependencies/AMReX.cmake') }}
+        restore-keys: |
+          ccache-cuda-nvhpc-${{ hashFiles('.github/workflows/cuda.yml') }}-
+          ccache-cuda-nvhpc-
     - name: Build & Install
       run: |
         source /etc/profile.d/modules.sh

.github/workflows/dependencies/dpcpp.sh

@@ -21,6 +21,7 @@ df -h
 # https://github.com/ECP-WarpX/WarpX/pull/1566#issuecomment-790934878
 sudo apt-get install -y --no-install-recommends \
     build-essential \
+    ccache          \
     cmake           \
     intel-oneapi-dpcpp-cpp-compiler intel-oneapi-mkl-devel \
     g++ gfortran    \

.github/workflows/dependencies/gcc.sh

@@ -11,6 +11,7 @@ sudo apt-get -qqq update
 sudo apt-get install -y \
     build-essential     \
     ca-certificates     \
+    ccache              \
     cmake               \
     gnupg               \
     ninja-build         \

.github/workflows/dependencies/hip.sh

@@ -25,6 +25,7 @@ sudo apt-get update
 # other: rocm-dev rocm-utils
 sudo apt-get install -y --no-install-recommends \
     build-essential \
+    ccache          \
     gfortran        \
     libnuma-dev     \
     libopenmpi-dev  \

.github/workflows/dependencies/icc.sh

@@ -11,8 +11,9 @@ export DEBIAN_FRONTEND=noninteractive
 sudo apt-get -qqq update
 sudo apt-get install -y \
   build-essential \
-  cmake           \
   ca-certificates \
+  ccache          \
+  cmake           \
   gnupg           \
   pkg-config      \
   wget

.github/workflows/dependencies/nvcc11.sh

@@ -11,6 +11,7 @@ sudo apt-get -qqq update
 sudo apt-get install -y \
     build-essential     \
     ca-certificates     \
+    ccache              \
     cmake               \
     gnupg               \
     libopenmpi-dev      \

.github/workflows/dependencies/nvhpc.sh

@@ -10,6 +10,7 @@ sudo apt-get -qqq update
 sudo apt-get install -y \
     build-essential     \
     ca-certificates     \
+    ccache              \
     cmake               \
     environment-modules \
     gnupg               \

.github/workflows/hip.yml

@@ -19,6 +19,16 @@ jobs:
     - name: install dependencies
       shell: bash
       run: .github/workflows/dependencies/hip.sh
+    - name: CCache Cache
+      uses: actions/cache@v2
+      # - once stored under a key, they become immutable (even if local cache path content changes)
+      # - for a refresh the key has to change, e.g., hash of a tracked file in the key
+      with:
+        path: ~/.ccache
+        key: ccache-hip-3dsp-${{ hashFiles('.github/workflows/hip.yml') }}-${{ hashFiles('cmake/dependencies/AMReX.cmake') }}
+        restore-keys: |
+          ccache-hip-3dsp-${{ hashFiles('.github/workflows/hip.yml') }}-
+          ccache-hip-3dsp-
     - name: build WarpX
       shell: bash
       run: |
@@ -62,6 +72,16 @@ jobs:
     - name: install dependencies
       shell: bash
       run: .github/workflows/dependencies/hip.sh
+    - name: CCache Cache
+      uses: actions/cache@v2
+      # - once stored under a key, they become immutable (even if local cache path content changes)
+      # - for a refresh the key has to change, e.g., hash of a tracked file in the key
+      with:
+        path: ~/.ccache
+        key: ccache-hip-2ddp-${{ hashFiles('.github/workflows/hip.yml') }}-${{ hashFiles('cmake/dependencies/AMReX.cmake') }}
+        restore-keys: |
+          ccache-hip-2ddp-${{ hashFiles('.github/workflows/hip.yml') }}-
+          ccache-hip-2ddp-
     - name: build WarpX
       shell: bash
       run: |

.github/workflows/intel.yml

@@ -21,6 +21,16 @@ jobs:
     - name: install dependencies
       run: |
         .github/workflows/dependencies/icc.sh
+    - name: CCache Cache
+      uses: actions/cache@v2
+      # - once stored under a key, they become immutable (even if local cache path content changes)
+      # - for a refresh the key has to change, e.g., hash of a tracked file in the key
+      with:
+        path: ~/.ccache
+        key: ccache-intel-icc-${{ hashFiles('.github/workflows/intel.yml') }}-${{ hashFiles('cmake/dependencies/AMReX.cmake') }}
+        restore-keys: |
+          ccache-intel-icc-${{ hashFiles('.github/workflows/intel.yml') }}-
+          ccache-intel-icc-
     - name: build WarpX
       run: |
         set +eu
@@ -64,6 +74,16 @@ jobs:
       shell: bash
       run: |
         .github/workflows/dependencies/dpcpp.sh
+    - name: CCache Cache
+      uses: actions/cache@v2
+      # - once stored under a key, they become immutable (even if local cache path content changes)
+      # - for a refresh the key has to change, e.g., hash of a tracked file in the key
+      with:
+        path: ~/.ccache
+        key: ccache-intel-icpx-${{ hashFiles('.github/workflows/intel.yml') }}-${{ hashFiles('cmake/dependencies/AMReX.cmake') }}
+        restore-keys: |
+          ccache-intel-icpx-${{ hashFiles('.github/workflows/intel.yml') }}-
+          ccache-intel-icpx-
     - name: build WarpX
       shell: bash
       run: |
@@ -110,6 +130,16 @@ jobs:
       shell: bash
       run: |
         .github/workflows/dependencies/dpcpp.sh
+    - name: CCache Cache
+      uses: actions/cache@v2
+      # - once stored under a key, they become immutable (even if local cache path content changes)
+      # - for a refresh the key has to change, e.g., hash of a tracked file in the key
+      with:
+        path: ~/.ccache
+        key: ccache-intel-dpcc-${{ hashFiles('.github/workflows/intel.yml') }}-${{ hashFiles('cmake/dependencies/AMReX.cmake') }}
+        restore-keys: |
+          ccache-intel-dpcc-${{ hashFiles('.github/workflows/intel.yml') }}-
+          ccache-intel-dpcc-
     - name: build WarpX
       shell: bash
       run: |

.github/workflows/macos.yml

@@ -26,6 +26,7 @@ jobs:
         set +e
         rm -rf /usr/local/bin/2to3
         brew update
+        brew install ccache
         brew install fftw
         brew install libomp
         brew install ninja
@@ -34,6 +35,16 @@ jobs:
         set -e
         brew tap openpmd/openpmd
         brew install openpmd-api
+    - name: CCache Cache
+      uses: actions/cache@v2
+      # - once stored under a key, they become immutable (even if local cache path content changes)
+      # - for a refresh the key has to change, e.g., hash of a tracked file in the key
+      with:
+        path: ~/.ccache
+        key: ccache-macos-appleclang-${{ hashFiles('.github/workflows/macos.yml') }}-${{ hashFiles('cmake/dependencies/AMReX.cmake') }}
+        restore-keys: |
+          ccache-macos-appleclang-${{ hashFiles('.github/workflows/macos.yml') }}-
+          ccache-macos-appleclang-
     - name: build WarpX
       run: |
         cmake -S . -B build_dp         \