Install ccache latest released version instead of version from package manager (#90)

bthomee · web-flow · commit f07de7f051d5 · 2026-01-06T11:00:23.000-05:00
Ccache has had many improvements over the years, including one that no
longer considers the `-fprofile-update=atomic` compiler flag to be
unsupported. This change therefore installs the most recent version
directly from their GitHub repo instead of using the version bundled by
the OS package manager.

However, note that RHEL 8 and Debian Bullseye do not support the latest
version due to the GLIBC version of the distro being too old. While an
older ccache version could be installed, these are only available for
direct download for x86_64. Since we don't use the problematic flag on
these two distros (and, since we release using Debian Bullseye where we
disable ccache anyway), this is fine.

Also note that as the flags in the README and CI were an unorganized
mess, I've ordered them as follows, which should make things more
readable:
* OS version (e.g. DEBIAN_VERSION)
* Compiler version (CLANG_VERSION, GCC_VERSION, BASE_IMAGE)
* Flags (alphabetical).
diff --git a/.github/workflows/debian.yml b/.github/workflows/debian.yml
@@ -27,13 +27,14 @@ env:
   PUSH: ${{ github.event_name == 'push' }}
   CONTAINER_REGISTRY: ghcr.io
   BUILDKIT_PROGRESS: plain
+  FALLBACK_GCC: 12
+  FALLBACK_CLANG: 16
+  CCACHE_VERSION: 4.12.2
+  CMAKE_VERSION: 4.1.0
   CONAN_VERSION: 2.22.2
   GCOVR_VERSION: 8.3
-  CMAKE_VERSION: 4.1.0
   MOLD_VERSION: 2.40.4
   RUST_VERSION: 1.91.1
-  FALLBACK_GCC: 12
-  FALLBACK_CLANG: 16
 
 jobs:
   # Build the Docker image for Debian using different versions of GCC and Clang.
@@ -149,15 +150,16 @@ jobs:
           build-args: |
             BUILDKIT_DOCKERFILE_CHECK=skip=InvalidDefaultArgInFrom
             BUILDKIT_INLINE_CACHE=1
+            DEBIAN_VERSION=${{ matrix.os.release }}
             CLANG_VERSION=${{ matrix.os.compiler_name == 'clang' && matrix.os.compiler_version || env.FALLBACK_CLANG }}
-            CONAN_VERSION=${{ env.CONAN_VERSION }}
             GCC_VERSION=${{ matrix.os.compiler_name == 'gcc' && matrix.os.compiler_version || env.FALLBACK_GCC }}
-            GCOVR_VERSION=${{ env.GCOVR_VERSION }}
+            BASE_IMAGE=${{ env.CONTAINER_IMAGE_GCC && format('{0}:{1}-{2}', env.CONTAINER_IMAGE_GCC, matrix.os.compiler_version, matrix.os.release) || format('gcc:{0}-{1}', matrix.os.compiler_version, matrix.os.release) }}
+            CCACHE_VERSION=${{ env.CCACHE_VERSION }}
             CMAKE_VERSION=${{ env.CMAKE_VERSION }}
+            CONAN_VERSION=${{ env.CONAN_VERSION }}
+            GCOVR_VERSION=${{ env.GCOVR_VERSION }}
             MOLD_VERSION=${{ env.MOLD_VERSION }}
             RUST_VERSION=${{ env.RUST_VERSION }}
-            DEBIAN_VERSION=${{ matrix.os.release }}
-            BASE_IMAGE=${{ env.CONTAINER_IMAGE_GCC && format('{0}:{1}-{2}', env.CONTAINER_IMAGE_GCC, matrix.os.compiler_version, matrix.os.release) || format('gcc:{0}-{1}', matrix.os.compiler_version, matrix.os.release) }}
           context: .
           file: docker/debian/Dockerfile
           outputs: type=image,name=${{ env.CONTAINER_IMAGE }},push-by-digest=true,name-canonical=true,push=${{ env.PUSH }}
diff --git a/.github/workflows/rhel.yml b/.github/workflows/rhel.yml
@@ -27,9 +27,10 @@ env:
   PUSH: ${{ github.event_name == 'push' }}
   CONTAINER_REGISTRY: ghcr.io
   BUILDKIT_PROGRESS: plain
+  CCACHE_VERSION: 4.12.2
+  CMAKE_VERSION: 4.1.0
   CONAN_VERSION: 2.22.2
   GCOVR_VERSION: 8.3
-  CMAKE_VERSION: 4.1.0
   MOLD_VERSION: 2.40.4
   RUST_VERSION: 1.91.1
 
@@ -118,13 +119,14 @@ jobs:
           build-args: |
             BUILDKIT_DOCKERFILE_CHECK=skip=InvalidDefaultArgInFrom
             BUILDKIT_INLINE_CACHE=1
-            CONAN_VERSION=${{ env.CONAN_VERSION }}
+            RHEL_VERSION=${{ matrix.os.release }}
             GCC_VERSION=${{ matrix.os.compiler_version }}
-            GCOVR_VERSION=${{ env.GCOVR_VERSION }}
+            CCACHE_VERSION=${{ env.CCACHE_VERSION }}
             CMAKE_VERSION=${{ env.CMAKE_VERSION }}
+            CONAN_VERSION=${{ env.CONAN_VERSION }}
+            GCOVR_VERSION=${{ env.GCOVR_VERSION }}
             MOLD_VERSION=${{ env.MOLD_VERSION }}
             RUST_VERSION=${{ env.RUST_VERSION }}
-            RHEL_VERSION=${{ matrix.os.release }}
           context: .
           file: docker/rhel/Dockerfile
           outputs: type=image,name=${{ env.CONTAINER_IMAGE }},push-by-digest=true,name-canonical=true,push=${{ env.PUSH }}
diff --git a/.github/workflows/ubuntu.yml b/.github/workflows/ubuntu.yml
@@ -27,13 +27,14 @@ env:
   PUSH: ${{ github.event_name == 'push' }}
   CONTAINER_REGISTRY: ghcr.io
   BUILDKIT_PROGRESS: plain
+  FALLBACK_GCC: 12
+  FALLBACK_CLANG: 16
+  CCACHE_VERSION: 4.12.2
+  CMAKE_VERSION: 4.1.0
   CONAN_VERSION: 2.22.2
   GCOVR_VERSION: 8.3
-  CMAKE_VERSION: 4.1.0
   MOLD_VERSION: 2.40.4
   RUST_VERSION: 1.91.1
-  FALLBACK_GCC: 12
-  FALLBACK_CLANG: 16
 
 jobs:
   # Build the Docker image for Ubuntu using different versions of GCC and Clang.
@@ -120,14 +121,15 @@ jobs:
           build-args: |
             BUILDKIT_DOCKERFILE_CHECK=skip=InvalidDefaultArgInFrom
             BUILDKIT_INLINE_CACHE=1
+            UBUNTU_VERSION=${{ matrix.os.release }}
             CLANG_VERSION=${{ matrix.os.compiler_name == 'clang' && matrix.os.compiler_version || env.FALLBACK_CLANG }}
-            CONAN_VERSION=${{ env.CONAN_VERSION }}
             GCC_VERSION=${{ matrix.os.compiler_name == 'gcc' && matrix.os.compiler_version || env.FALLBACK_GCC }}
-            GCOVR_VERSION=${{ env.GCOVR_VERSION }}
+            CCACHE_VERSION=${{ env.CCACHE_VERSION }}
             CMAKE_VERSION=${{ env.CMAKE_VERSION }}
+            CONAN_VERSION=${{ env.CONAN_VERSION }}
+            GCOVR_VERSION=${{ env.GCOVR_VERSION }}
             MOLD_VERSION=${{ env.MOLD_VERSION }}
             RUST_VERSION=${{ env.RUST_VERSION }}
-            UBUNTU_VERSION=${{ matrix.os.release }}
           context: .
           file: docker/ubuntu/Dockerfile
           outputs: type=image,name=${{ env.CONTAINER_IMAGE }},push-by-digest=true,name-canonical=true,push=${{ env.PUSH }}
diff --git a/docker/debian/Dockerfile b/docker/debian/Dockerfile
@@ -15,6 +15,9 @@ FROM ${BASE_IMAGE} AS gcc-src
 # ====================== BASE IMAGE ======================
 FROM debian:${DEBIAN_VERSION} AS base
 
+# This is not inherited from the base image.
+ARG DEBIAN_VERSION
+
 # Use Bash as the default shell for RUN commands, using the options
 # `set -o errexit -o pipefail`, and as the entrypoint.
 SHELL ["/bin/bash", "-e", "-o", "pipefail", "-c"]
@@ -40,7 +43,6 @@ RUN <<EOF
 pkgs=()
 pkgs+=(ca-certificates) # Enable TLS verification for HTTPS connections by providing trusted root certificates.
 pkgs+=(binutils-gold)   # Required build tool.
-pkgs+=(ccache)          # Optional build tool for caching build artifacts.
 pkgs+=(curl)            # Dependency for tools requiring downloading data.
 pkgs+=(dpkg-dev)        # Required packaging tool.
 pkgs+=(debhelper)       # Required packaging tool.
@@ -77,7 +79,28 @@ RUN pip install --no-cache \
   gcovr==${GCOVR_VERSION} \
   cmake==${CMAKE_VERSION}
 
-# Install mold https://github.com/rui314/mold
+# Install ccache. Note that the ccache version from the package manager is
+# installed for Debian Bullseye, as the latest version requires a newer GLIBC
+# version, and older compatible releases are x86-64 only.
+ARG CCACHE_VERSION
+
+RUN <<EOF
+if [[ "${DEBIAN_VERSION}" == "bullseye" ]]; then
+  apt-get update
+  apt-get install -y --no-install-recommends ccache
+  apt-get clean
+  rm -rf /var/lib/apt/lists/*
+else
+  ARCH=$(uname -m)
+  wget -O ccache.tar.xz https://github.com/ccache/ccache/releases/download/v${CCACHE_VERSION}/ccache-${CCACHE_VERSION}-linux-${ARCH}.tar.xz
+  tar -xf ccache.tar.xz
+  cp ccache-${CCACHE_VERSION}-linux-${ARCH}/ccache /usr/local/bin
+  rm -r ccache-${CCACHE_VERSION}-linux-${ARCH}
+  rm ccache.tar.xz
+fi
+EOF
+
+# Install mold.
 ARG MOLD_VERSION
 
 RUN <<EOF
diff --git a/docker/debian/README.md b/docker/debian/README.md
@@ -38,9 +38,10 @@ directory of the repository.
 ```shell
 DEBIAN_VERSION=bookworm
 GCC_VERSION=12
+CCACHE_VERSION=4.12.2
+CMAKE_VERSION=4.1.0
 CONAN_VERSION=2.22.2
 GCOVR_VERSION=8.3
-CMAKE_VERSION=4.1.0
 MOLD_VERSION=2.40.4
 RUST_VERSION=1.91.1
 CONTAINER_IMAGE=ghcr.io/xrplf/ci/debian-${DEBIAN_VERSION}:gcc-${GCC_VERSION}
@@ -50,11 +51,12 @@ docker buildx build . \
   --target gcc \
   --build-arg BUILDKIT_DOCKERFILE_CHECK=skip=InvalidDefaultArgInFrom \
   --build-arg BUILDKIT_INLINE_CACHE=1 \
-  --build-arg CONAN_VERSION=${CONAN_VERSION} \
   --build-arg DEBIAN_VERSION=${DEBIAN_VERSION} \
   --build-arg GCC_VERSION=${GCC_VERSION} \
-  --build-arg GCOVR_VERSION=${GCOVR_VERSION} \
+  --build-arg CCACHE_VERSION=${CCACHE_VERSION} \
   --build-arg CMAKE_VERSION=${CMAKE_VERSION} \
+  --build-arg CONAN_VERSION=${CONAN_VERSION} \
+  --build-arg GCOVR_VERSION=${GCOVR_VERSION} \
   --build-arg MOLD_VERSION=${MOLD_VERSION} \
   --build-arg RUST_VERSION=${RUST_VERSION} \
   --tag ${CONTAINER_IMAGE}
@@ -66,27 +68,29 @@ In order to build a GCC image for Bullseye, you also need to explicitly set
 ```shell
 DEBIAN_VERSION=bullseye
 GCC_VERSION=12
+BASE_IMAGE=ghcr.io/xrplf/ci/gcc:${GCC_VERSION}-bullseye
+CCACHE_VERSION=4.12.2
+CMAKE_VERSION=4.1.0
 CONAN_VERSION=2.22.2
 GCOVR_VERSION=8.3
-CMAKE_VERSION=4.1.0
 MOLD_VERSION=2.40.4
 RUST_VERSION=1.91.1
-BASE_IMAGE=ghcr.io/xrplf/ci/gcc:12-bullseye
 CONTAINER_IMAGE=ghcr.io/xrplf/ci/debian-${DEBIAN_VERSION}:gcc-${GCC_VERSION}
 
 docker buildx build . \
   --file docker/debian/Dockerfile \
   --target gcc \
   --build-arg BUILDKIT_DOCKERFILE_CHECK=skip=InvalidDefaultArgInFrom \
   --build-arg BUILDKIT_INLINE_CACHE=1 \
-  --build-arg CONAN_VERSION=${CONAN_VERSION} \
   --build-arg DEBIAN_VERSION=${DEBIAN_VERSION} \
   --build-arg GCC_VERSION=${GCC_VERSION} \
-  --build-arg GCOVR_VERSION=${GCOVR_VERSION} \
+  --build-arg BASE_IMAGE=${BASE_IMAGE} \
+  --build-arg CCACHE_VERSION=${CCACHE_VERSION} \
   --build-arg CMAKE_VERSION=${CMAKE_VERSION} \
+  --build-arg CONAN_VERSION=${CONAN_VERSION} \
+  --build-arg GCOVR_VERSION=${GCOVR_VERSION} \
   --build-arg MOLD_VERSION=${MOLD_VERSION} \
   --build-arg RUST_VERSION=${RUST_VERSION} \
-  --build-arg BASE_IMAGE=${BASE_IMAGE} \
   --tag ${CONTAINER_IMAGE}
 ```
 
@@ -98,9 +102,10 @@ directory of the repository.
 ```shell
 DEBIAN_VERSION=bookworm
 CLANG_VERSION=17
+CCACHE_VERSION=4.12.2
+CMAKE_VERSION=4.1.0
 CONAN_VERSION=2.22.2
 GCOVR_VERSION=8.3
-CMAKE_VERSION=4.1.0
 MOLD_VERSION=2.40.4
 RUST_VERSION=1.91.1
 CONTAINER_IMAGE=ghcr.io/xrplf/ci/debian-${DEBIAN_VERSION}:clang-${CLANG_VERSION}
@@ -110,11 +115,12 @@ docker buildx build . \
   --target clang \
   --build-arg BUILDKIT_DOCKERFILE_CHECK=skip=InvalidDefaultArgInFrom \
   --build-arg BUILDKIT_INLINE_CACHE=1 \
+  --build-arg DEBIAN_VERSION=${DEBIAN_VERSION} \
   --build-arg CLANG_VERSION=${CLANG_VERSION} \
+  --build-arg CCACHE_VERSION=${CCACHE_VERSION} \
+  --build-arg CMAKE_VERSION=${CMAKE_VERSION} \
   --build-arg CONAN_VERSION=${CONAN_VERSION} \
-  --build-arg DEBIAN_VERSION=${DEBIAN_VERSION} \
   --build-arg GCOVR_VERSION=${GCOVR_VERSION} \
-  --build-arg CMAKE_VERSION=${CMAKE_VERSION} \
   --build-arg MOLD_VERSION=${MOLD_VERSION} \
   --build-arg RUST_VERSION=${RUST_VERSION} \
   --tag ${CONTAINER_IMAGE}
diff --git a/docker/rhel/Dockerfile b/docker/rhel/Dockerfile
@@ -23,12 +23,11 @@ EOF
 RUN <<EOF
 pkgs=()
 pkgs+=(ca-certificates)   # Enable TLS verification for HTTPS connections by providing trusted root certificates.
-if [ "${RHEL_VERSION}" -eq "8" ]; then
+if [[ "${RHEL_VERSION}" == "8" ]]; then
   pkgs+=(binutils)        # Required build tool.
 else
   pkgs+=(binutils-gold)   # Required build tool.
 fi
-pkgs+=(ccache)            # Optional build tool for caching build artifacts.
 pkgs+=(file)              # Required packaging tool.
 pkgs+=(git)               # Required build tool.
 pkgs+=(gpg)               # Dependency for tools requiring signing or encrypting/decrypting.
@@ -91,7 +90,28 @@ RUN pip install --no-cache \
   gcovr==${GCOVR_VERSION} \
   cmake==${CMAKE_VERSION}
 
-# Install mold https://github.com/rui314/mold
+# Install ccache. Note that the ccache version from the package manager is
+# installed for RHEL 8, as the latest version requires a newer GLIBC version,
+# and older compatible releases are x86-64 only.
+ARG CCACHE_VERSION
+
+RUN <<EOF
+if [[ "${RHEL_VERSION}" == "8" ]]; then
+  dnf update -y
+  dnf install -y --allowerasing --setopt=tsflags=nodocs ccache
+  dnf clean -y all
+  rm -rf /var/cache/dnf/*
+else
+  ARCH=$(uname -m)
+  wget -O ccache.tar.xz https://github.com/ccache/ccache/releases/download/v${CCACHE_VERSION}/ccache-${CCACHE_VERSION}-linux-${ARCH}.tar.xz
+  tar -xf ccache.tar.xz
+  cp ccache-${CCACHE_VERSION}-linux-${ARCH}/ccache /usr/local/bin
+  rm -r ccache-${CCACHE_VERSION}-linux-${ARCH}
+  rm ccache.tar.xz
+fi
+EOF
+
+# Install mold.
 ARG MOLD_VERSION
 
 RUN <<EOF
diff --git a/docker/rhel/README.md b/docker/rhel/README.md
@@ -25,9 +25,10 @@ directory of the repository.
 ```shell
 RHEL_VERSION=9
 GCC_VERSION=12
+CCACHE_VERSION=4.12.2
+CMAKE_VERSION=4.1.0
 CONAN_VERSION=2.22.2
 GCOVR_VERSION=8.3
-CMAKE_VERSION=4.1.0
 MOLD_VERSION=2.40.4
 RUST_VERSION=1.91.1
 CONTAINER_IMAGE=ghcr.io/xrplf/ci/rhel-${RHEL_VERSION}:gcc-${GCC_VERSION}
@@ -37,13 +38,14 @@ docker buildx build . \
   --target gcc \
   --build-arg BUILDKIT_DOCKERFILE_CHECK=skip=InvalidDefaultArgInFrom \
   --build-arg BUILDKIT_INLINE_CACHE=1 \
-  --build-arg CONAN_VERSION=${CONAN_VERSION} \
+  --build-arg RHEL_VERSION=${RHEL_VERSION} \
   --build-arg GCC_VERSION=${GCC_VERSION} \
-  --build-arg GCOVR_VERSION=${GCOVR_VERSION} \
+  --build-arg CCACHE_VERSION=${CCACHE_VERSION} \
   --build-arg CMAKE_VERSION=${CMAKE_VERSION} \
+  --build-arg CONAN_VERSION=${CONAN_VERSION} \
+  --build-arg GCOVR_VERSION=${GCOVR_VERSION} \
   --build-arg MOLD_VERSION=${MOLD_VERSION} \
   --build-arg RUST_VERSION=${RUST_VERSION} \
-  --build-arg RHEL_VERSION=${RHEL_VERSION} \
   --tag ${CONTAINER_IMAGE}
 ```
 
@@ -54,9 +56,10 @@ directory of the repository.
 
 ```shell
 RHEL_VERSION=10
+CCACHE_VERSION=4.12.2
+CMAKE_VERSION=4.1.0
 CONAN_VERSION=2.22.2
 GCOVR_VERSION=8.3
-CMAKE_VERSION=4.1.0
 MOLD_VERSION=2.40.4
 RUST_VERSION=1.91.1
 CONTAINER_IMAGE=ghcr.io/xrplf/ci/rhel-${RHEL_VERSION}:clang-any
@@ -66,12 +69,13 @@ docker buildx build . \
   --target clang \
   --build-arg BUILDKIT_DOCKERFILE_CHECK=skip=InvalidDefaultArgInFrom \
   --build-arg BUILDKIT_INLINE_CACHE=1 \
+  --build-arg RHEL_VERSION=${RHEL_VERSION} \
+  --build-arg CCACHE_VERSION=${CCACHE_VERSION} \
+  --build-arg CMAKE_VERSION=${CMAKE_VERSION} \
   --build-arg CONAN_VERSION=${CONAN_VERSION} \
   --build-arg GCOVR_VERSION=${GCOVR_VERSION} \
-  --build-arg CMAKE_VERSION=${CMAKE_VERSION} \
   --build-arg MOLD_VERSION=${MOLD_VERSION} \
   --build-arg RUST_VERSION=${RUST_VERSION} \
-  --build-arg RHEL_VERSION=${RHEL_VERSION} \
   --tag ${CONTAINER_IMAGE}
 ```
 
diff --git a/docker/ubuntu/Dockerfile b/docker/ubuntu/Dockerfile
@@ -27,7 +27,6 @@ RUN <<EOF
 pkgs=()
 pkgs+=(ca-certificates) # Enable TLS verification for HTTPS connections by providing trusted root certificates.
 pkgs+=(binutils-gold)   # Required build tool.
-pkgs+=(ccache)          # Optional build tool for caching build artifacts.
 pkgs+=(curl)            # Dependency for tools requiring downloading data.
 pkgs+=(dpkg-dev)        # Required packaging tool.
 pkgs+=(file)            # Required packaging tool.
@@ -63,7 +62,19 @@ RUN pip install --no-cache \
   gcovr==${GCOVR_VERSION} \
   cmake==${CMAKE_VERSION}
 
-# Install mold https://github.com/rui314/mold
+# Install ccache.
+ARG CCACHE_VERSION
+
+RUN <<EOF
+ARCH=$(uname -m)
+wget -O ccache.tar.xz https://github.com/ccache/ccache/releases/download/v${CCACHE_VERSION}/ccache-${CCACHE_VERSION}-linux-${ARCH}.tar.xz
+tar -xf ccache.tar.xz
+cp ccache-${CCACHE_VERSION}-linux-${ARCH}/ccache /usr/local/bin
+rm -r ccache-${CCACHE_VERSION}-linux-${ARCH}
+rm ccache.tar.xz
+EOF
+
+# Install mold.
 ARG MOLD_VERSION
 
 RUN <<EOF
diff --git a/docker/ubuntu/README.md b/docker/ubuntu/README.md
