add ccache eviction for files older than 7 days (#6795)

* add ccache eviction for files older than 7 days

also clean up some of the scripts to be more internally consistent

* move name build into the docker container again

* remove one extra empty line [skip ci]

* allow canceling concurrent builds on master for both desktop and docker

* add ccache eviction age to macos as well

.ci/compile.sh

@@ -10,9 +10,11 @@
 # --test runs tests
 # --debug or --release sets the build type ie CMAKE_BUILD_TYPE
 # --ccache [<size>] uses ccache and shows stats, optionally provide size
+# --evict-ccache <age> runs ccache eviction based on given age after build
 # --dir <dir> sets the name of the build dir, default is "build"
+# --cmake-generator <generator> sets CMAKE_GENERATOR as used by cmake
 # --target-macos-version <version> sets the min os version - only used for macOS builds
-# uses env: BUILDTYPE MAKE_INSTALL MAKE_PACKAGE PACKAGE_TYPE PACKAGE_SUFFIX MAKE_SERVER MAKE_NO_CLIENT MAKE_TEST USE_CCACHE CCACHE_SIZE BUILD_DIR CMAKE_GENERATOR TARGET_MACOS_VERSION
+# uses env: BUILDTYPE MAKE_INSTALL MAKE_PACKAGE PACKAGE_TYPE PACKAGE_SUFFIX MAKE_SERVER MAKE_NO_CLIENT MAKE_TEST USE_CCACHE CCACHE_SIZE CCACHE_EVICTION_AGE BUILD_DIR CMAKE_GENERATOR TARGET_MACOS_VERSION
 # (correspond to args: --debug/--release --install --package <package type> --suffix <suffix> --server --test --ccache <ccache_size> --dir <dir>)
 # exitcode: 1 for failure, 3 for invalid arguments
 
@@ -71,6 +73,15 @@ while [[ $# != 0 ]]; do
         shift
       fi
       ;;
+    '--evict-ccache')
+      shift
+      if [[ $# == 0 ]]; then
+        echo "::error file=$0::--evict-ccache expects an argument"
+        exit 3
+      fi
+      CCACHE_EVICTION_AGE=$1
+      shift
+      ;;
     '--vcpkg')
       USE_VCPKG=1
       shift
@@ -84,6 +95,15 @@ while [[ $# != 0 ]]; do
       BUILD_DIR="$1"
       shift
       ;;
+    '--cmake-generator')
+      shift
+      if [[ $# == 0 ]]; then
+        echo "::error file=$0::--cmake-generator expects an argument"
+        exit 3
+      fi
+      export CMAKE_GENERATOR=$1
+      shift
+      ;;
     '--target-macos-version')
       shift
       if [[ $# == 0 ]]; then
@@ -251,9 +271,16 @@ cmake --build . "${buildflags[@]}"
 echo "::endgroup::"
 
 if [[ $USE_CCACHE ]]; then
+  if [[ $CCACHE_EVICTION_AGE ]]; then
+    echo "::group::evict ccache files older than $CCACHE_EVICTION_AGE"
+    ccache --evict-older-than "$CCACHE_EVICTION_AGE"
+    echo "::endgroup::"
+  fi
   echo "::group::Show ccache stats again"
   ccachestatsverbose
   echo "::endgroup::"
+elif [[ $CCACHE_EVICTION_AGE ]]; then
+  echo "::error file=$0::ccache eviction is enabled while ccache is disabled!"
 fi
 
 if [[ $RUNNER_OS == macOS ]]; then

.ci/docker.sh

@@ -3,17 +3,28 @@
 # This script is to be used by the ci environment from the project root directory, do not use it from somewhere else.
 
 # Creates or loads docker images to use in compilation, creates RUN function to start compilation on the docker image.
-# <arg> sets the name of the docker image, these correspond to directories in .ci
+#
+# usage: source <script> <name> [--get] [--build] [--save] [--interactive] [--set-cache <location>]
+# <name> sets the name of the docker image, these correspond to directories in .ci
 # --get loads the image from a previously saved image cache, will build if no image is found
 # --build builds the image from the Dockerfile in .ci/$NAME
 # --save stores the image, if an image was loaded it will not be stored
 # --interactive immediately starts the image interactively for debugging
 # --set-cache <location> sets the location to cache the image or for ccache
+#
 # requires: docker
 # uses env: NAME CACHE BUILD GET SAVE INTERACTIVE
 # (correspond to args: <name> --set-cache <cache> --build --get --save --interactive)
 # sets env: RUN CCACHE_DIR IMAGE_NAME RUN_ARGS RUN_OPTS BUILD_SCRIPT
 # exitcode: 1 for failure, 2 for missing dockerfile, 3 for invalid arguments
+#
+# exported RUN function will run the BUILD_SCRIPT inside of the docker container.
+# note that the docker container will not inherit any environment variables!
+#
+# usage: RUN [arguments for build script]
+# roughly equivalent to `docker run $IMAGE_NAME bash $BUILD_SCRIPT $@`
+# uses env: CCACHE_DIR IMAGE_NAME RUN_ARGS RUN_OPTS BUILD_SCRIPT
+# exitcode: 3 for invalid arguments, returns the returncode of docker run
 export BUILD_SCRIPT=".ci/compile.sh"
 
 project_name="cockatrice"
@@ -41,12 +52,17 @@ while [[ $# != 0 ]]; do
       shift
       ;;
     '--set-cache')
-      CACHE=$2
+      shift
+      if [[ $# == 0 ]]; then
+        echo "--set-cache expects an argument" >&2
+        exit 3
+      fi
+      CACHE=$1
+      shift
       if ! [[ -d $CACHE ]]; then
         echo "could not find cache path: $CACHE" >&2
         return 3
       fi
-      shift 2
       ;;
     *)
       if [[ ${1:0:1} == - ]]; then
@@ -149,10 +165,11 @@ function RUN ()
       args+=(--mount "type=bind,source=$CCACHE_DIR,target=/.ccache")
       args+=(--env "CCACHE_DIR=/.ccache")
     fi
-    if [[ -n "$CMAKE_GENERATOR" ]]; then
-      args+=(--env "CMAKE_GENERATOR=$CMAKE_GENERATOR")
+    if [[ $GITHUB_OUTPUT ]]; then
+      args+=(--mount "type=bind,source=$GITHUB_OUTPUT,target=/gh_output")
+      args+=(--env "GITHUB_OUTPUT=/gh_output")
     fi
-  # shellcheck disable=2086
+    # shellcheck disable=2086
     docker run "${args[@]}" $RUN_ARGS "$IMAGE_NAME" bash "$BUILD_SCRIPT" $RUN_OPTS "$@"
     return $?
   else

.github/workflows/desktop-build.yml

@@ -38,10 +38,10 @@ on:
       - 'vcpkg.json'
       - 'vcpkg'
 
-# Cancel earlier, unfinished runs of this workflow on the same branch (unless on master)
+# Cancel earlier, unfinished runs of this workflow on the same branch (unless on release)
 concurrency:
   group: "${{ github.workflow }} @ ${{ github.ref_name }}"
-  cancel-in-progress: ${{ github.ref_name != 'master' }}
+  cancel-in-progress: ${{ github.ref_type != 'tag' }}
 
 jobs:
   configure:
@@ -163,6 +163,7 @@ jobs:
       # Cache size over the entire repo is 10Gi:
       # https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy
       CCACHE_SIZE: 550M
+      CCACHE_EVICTION_AGE: 7d
       CMAKE_GENERATOR: 'Ninja'
 
     steps:
@@ -186,27 +187,32 @@ jobs:
       - name: Build debug and test
         if: matrix.test != 'skip'
         shell: bash
-        env:
-          CMAKE_GENERATOR: '${{env.CMAKE_GENERATOR}}'
         run: |
           source .ci/docker.sh
-          RUN --server --debug --test --ccache "$CCACHE_SIZE"
+          RUN --server --debug --test --ccache "$CCACHE_SIZE" \
+                  --cmake-generator "$CMAKE_GENERATOR"
 
       - name: Build release package
         id: build
         if: matrix.package != 'skip'
         shell: bash
         env:
-          BUILD_DIR: build
           SUFFIX: '-${{matrix.distro}}${{matrix.version}}'
           package: '${{matrix.package}}'
-          CMAKE_GENERATOR: '${{env.CMAKE_GENERATOR}}'
-          NO_CLIENT: ${{matrix.server_only == 'yes' && '--no-client' || '' }}
+          server_only: '${{matrix.server_only}}'
         run: |
           source .ci/docker.sh
-          RUN --server --release --package "$package" --dir "$BUILD_DIR" \
-                  --ccache "$CCACHE_SIZE" $NO_CLIENT
-          .ci/name_build.sh
+          args=()
+          if [[ $server_only == yes ]]; then
+            args+=(--no-client)
+          fi
+          if [[ $GITHUB_REF == "refs/heads/master" ]]; then
+            args+=(--evict-ccache "$CCACHE_EVICTION_AGE")
+          fi
+          args+=(--ccache "$CCACHE_SIZE")
+          args+=(--cmake-generator "$CMAKE_GENERATOR")
+          args+=(--suffix "$SUFFIX")
+          RUN --server --release --package "$package" "${args[@]}"
 
       # Delete used cache to emulate a ccache update. See https://github.com/actions/cache/issues/342
       - name: Delete remote compiler cache (ccache)
@@ -277,6 +283,7 @@ jobs:
             qt_modules: qtimageformats qtmultimedia qtwebsockets
             cmake_generator: Ninja
             use_ccache: 1
+            ccache_eviction_age: 7d
 
           - os: macOS
             target: 14
@@ -291,6 +298,7 @@ jobs:
             qt_modules: qtimageformats qtmultimedia qtwebsockets
             cmake_generator: Ninja
             use_ccache: 1
+            ccache_eviction_age: 7d
 
           - os: macOS
             target: 15
@@ -305,6 +313,7 @@ jobs:
             qt_modules: qtimageformats qtmultimedia qtwebsockets
             cmake_generator: Ninja
             use_ccache: 1
+            ccache_eviction_age: 7d
 
           - os: macOS
             target: 15
@@ -317,6 +326,7 @@ jobs:
             qt_modules: qtimageformats qtmultimedia qtwebsockets
             cmake_generator: Ninja
             use_ccache: 1
+            ccache_eviction_age: 7d
 
           - os: Windows
             target: 10
@@ -450,6 +460,7 @@ jobs:
           MACOS_CI_KEYCHAIN_PWD: ${{ secrets.PROD_MACOS_CI_KEYCHAIN_PWD }}
           DEVELOPER_DIR: '/Applications/Xcode_${{matrix.xcode}}.app/Contents/Developer'
           TARGET_MACOS_VERSION: ${{ matrix.override_target }}
+          CCACHE_EVICTION_AGE: ${{ matrix.ccache_eviction_age }}
         run: .ci/compile.sh --server --test --vcpkg
 
       # Delete used cache to emulate a ccache update. See https://github.com/actions/cache/issues/342

.github/workflows/docker-release.yml

@@ -13,6 +13,11 @@ on:
       - '.github/workflows/docker-release.yml'
       - 'Dockerfile'
 
+# Cancel earlier, unfinished runs of this workflow on the same branch (unless on release)
+concurrency:
+  group: "${{ github.workflow }} @ ${{ github.ref_name }}"
+  cancel-in-progress: ${{ github.ref_type != 'tag' }}
+
 jobs:
   docker:
     name: amd64 & arm64