CI: Decouple build and test into separate scripts, simplify workflows (#7871)
- Split the monolithic ci-script.bash into ci-build.bash and
ci-test.bash, with shared setup in ci-common.bash.
- Pass job parameters as explicit command-line options rather than
environment variables (--compiler, --prefix, --suite, --asan,
--gcov, --reloc, --ccwarn).
- Detect the host OS and distribution at runtime (uname,
/etc/os-release) instead of the legacy Travis-era CI_OS_NAME,
CI_RUNS_ON and CI_BUILD_STAGE_NAME variables.
- Remove dead code: FreeBSD support, Windows wavediff install, the
unused CI_COMMIT variable, and various redundant operations.
- Inline the single-entry build-job matrices.
- Rename osx to macOS
- Refuse to run these ci scripts outside GitHub Actions to protect
developer checkouts.
2026-07-05 16:46:30 +02:00
|
|
|
#!/usr/bin/env bash
|
|
|
|
|
# DESCRIPTION: Verilator: CI build job script
|
|
|
|
|
#
|
|
|
|
|
# SPDX-FileCopyrightText: 2026 Wilson Snyder
|
|
|
|
|
# SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
|
|
|
|
|
|
|
|
|
|
################################################################################
|
|
|
|
|
# Executed in the 'build' stage.
|
|
|
|
|
################################################################################
|
|
|
|
|
|
|
|
|
|
# Destructive to the checkout (reconfigures and rebuilds); never run locally
|
|
|
|
|
if [ "$GITHUB_ACTIONS" != "true" ]; then
|
|
|
|
|
echo "ERROR: $(basename "$0") must only be run in GitHub Actions CI" >&2
|
|
|
|
|
exit 1
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
set -e
|
|
|
|
|
set -x
|
|
|
|
|
|
|
|
|
|
source "$(dirname "$0")/ci-common.bash"
|
|
|
|
|
|
|
|
|
|
################################################################################
|
|
|
|
|
# Parse arguments
|
|
|
|
|
|
|
|
|
|
OPT_ASAN=0
|
|
|
|
|
OPT_CCWARN=0
|
|
|
|
|
OPT_GCOV=0
|
|
|
|
|
OPT_COMPILER=
|
|
|
|
|
OPT_PREFIX=
|
|
|
|
|
while [ $# -gt 0 ]; do
|
|
|
|
|
case "$1" in
|
|
|
|
|
--asan) OPT_ASAN=1 ;;
|
|
|
|
|
--ccwarn) OPT_CCWARN=1 ;;
|
|
|
|
|
--compiler)
|
|
|
|
|
[ $# -ge 2 ] || fatal "--compiler requires an argument"
|
|
|
|
|
OPT_COMPILER="$2"
|
|
|
|
|
shift
|
|
|
|
|
;;
|
|
|
|
|
--gcov) OPT_GCOV=1 ;;
|
|
|
|
|
--prefix)
|
|
|
|
|
[ $# -ge 2 ] || fatal "--prefix requires an argument"
|
|
|
|
|
OPT_PREFIX="$2"
|
|
|
|
|
shift
|
|
|
|
|
;;
|
|
|
|
|
*) fatal "Unknown option: '$1'" ;;
|
|
|
|
|
esac
|
|
|
|
|
shift
|
|
|
|
|
done
|
|
|
|
|
|
|
|
|
|
[ -n "$OPT_COMPILER" ] || fatal "--compiler is required"
|
|
|
|
|
[ -n "$OPT_PREFIX" ] || fatal "--prefix is required"
|
|
|
|
|
|
|
|
|
|
# Map the compiler name to the executable name configure CXX expects
|
|
|
|
|
case "$OPT_COMPILER" in
|
|
|
|
|
clang) CXX=clang++ ;;
|
|
|
|
|
gcc) CXX=g++ ;;
|
|
|
|
|
*) fatal "Unknown compiler: '$OPT_COMPILER'" ;;
|
|
|
|
|
esac
|
|
|
|
|
|
|
|
|
|
################################################################################
|
|
|
|
|
# Configure
|
|
|
|
|
|
2026-07-06 19:02:37 +02:00
|
|
|
CONFIGURE_ARGS="--prefix=$OPT_PREFIX --enable-longtests --enable-light-debug"
|
CI: Decouple build and test into separate scripts, simplify workflows (#7871)
- Split the monolithic ci-script.bash into ci-build.bash and
ci-test.bash, with shared setup in ci-common.bash.
- Pass job parameters as explicit command-line options rather than
environment variables (--compiler, --prefix, --suite, --asan,
--gcov, --reloc, --ccwarn).
- Detect the host OS and distribution at runtime (uname,
/etc/os-release) instead of the legacy Travis-era CI_OS_NAME,
CI_RUNS_ON and CI_BUILD_STAGE_NAME variables.
- Remove dead code: FreeBSD support, Windows wavediff install, the
unused CI_COMMIT variable, and various redundant operations.
- Inline the single-entry build-job matrices.
- Rename osx to macOS
- Refuse to run these ci scripts outside GitHub Actions to protect
developer checkouts.
2026-07-05 16:46:30 +02:00
|
|
|
if [ "$OPT_CCWARN" = 1 ]; then
|
|
|
|
|
CONFIGURE_ARGS="$CONFIGURE_ARGS --enable-ccwarn"
|
|
|
|
|
fi
|
|
|
|
|
if [ "$OPT_ASAN" = 1 ]; then
|
|
|
|
|
CONFIGURE_ARGS="$CONFIGURE_ARGS --enable-dev-asan"
|
|
|
|
|
CXX="$CXX -DVL_LEAK_CHECKS"
|
|
|
|
|
fi
|
|
|
|
|
if [ "$OPT_GCOV" = 1 ]; then
|
|
|
|
|
CONFIGURE_ARGS="$CONFIGURE_ARGS --enable-dev-gcov"
|
|
|
|
|
fi
|
|
|
|
|
autoconf
|
|
|
|
|
./configure $CONFIGURE_ARGS CXX="$CXX"
|
|
|
|
|
|
|
|
|
|
################################################################################
|
|
|
|
|
# Build
|
|
|
|
|
|
|
|
|
|
ccache -z
|
CI: Improve ccache handling in build and test jobs (#7874)
Cache key isolation: Include the build flavour (ccwarn/asan/gcov) in the
build ccache key, so the coverage (gcov), asan, and RTLMeter
(ccwarn-off) configurations no longer share and thrash the single
'<runs-on>-<cc>' bucket, nor warm-start from each other's (near-useless)
caches.
Prune stale entries instead of a fixed size cap: After building/testing,
evict ccache entries this run did not touch (--evict-older-than, based
on the run's own duration). This bounds the saved cache to the current
working set, so CCACHE_MAXSIZE and CCACHE_LIMIT_MULTIPLE are no longer
needed and are removed (ccache falls back to its 5G default ceiling, but
is realistically much smaller).
ccache configuration:
- Drop CCACHE_COMPRESS (already the default in ccache 4.x).
- Add CCACHE_COMPILERCHECK=content, so a changed compiler mtime on a rebuilt
ephemeral runner image does not invalidate the whole restored cache.
- Hoist all ccache-related variables (CACHE_BASE_KEY, CCACHE_*, CXX) to the
workflow-level env.
Remove dead ccache scaffolding:
- reusable-lint-py: the job never compiles or caches; drop its ccache env.
- reusable-rtlmeter-run: remove the disabled persistent-cache step and its
storage variables; keep CCACHE_DISABLE=1, since caching must stay off to
keep RTLMeter timings representative.
Store test job ccache as artifacts for reuse
2026-07-06 02:44:32 +02:00
|
|
|
BUILD_START=$SECONDS
|
CI: Decouple build and test into separate scripts, simplify workflows (#7871)
- Split the monolithic ci-script.bash into ci-build.bash and
ci-test.bash, with shared setup in ci-common.bash.
- Pass job parameters as explicit command-line options rather than
environment variables (--compiler, --prefix, --suite, --asan,
--gcov, --reloc, --ccwarn).
- Detect the host OS and distribution at runtime (uname,
/etc/os-release) instead of the legacy Travis-era CI_OS_NAME,
CI_RUNS_ON and CI_BUILD_STAGE_NAME variables.
- Remove dead code: FreeBSD support, Windows wavediff install, the
unused CI_COMMIT variable, and various redundant operations.
- Inline the single-entry build-job matrices.
- Rename osx to macOS
- Refuse to run these ci scripts outside GitHub Actions to protect
developer checkouts.
2026-07-05 16:46:30 +02:00
|
|
|
"$MAKE" -j "$NPROC" -k
|
|
|
|
|
ccache -svv
|
CI: Improve ccache handling in build and test jobs (#7874)
Cache key isolation: Include the build flavour (ccwarn/asan/gcov) in the
build ccache key, so the coverage (gcov), asan, and RTLMeter
(ccwarn-off) configurations no longer share and thrash the single
'<runs-on>-<cc>' bucket, nor warm-start from each other's (near-useless)
caches.
Prune stale entries instead of a fixed size cap: After building/testing,
evict ccache entries this run did not touch (--evict-older-than, based
on the run's own duration). This bounds the saved cache to the current
working set, so CCACHE_MAXSIZE and CCACHE_LIMIT_MULTIPLE are no longer
needed and are removed (ccache falls back to its 5G default ceiling, but
is realistically much smaller).
ccache configuration:
- Drop CCACHE_COMPRESS (already the default in ccache 4.x).
- Add CCACHE_COMPILERCHECK=content, so a changed compiler mtime on a rebuilt
ephemeral runner image does not invalidate the whole restored cache.
- Hoist all ccache-related variables (CACHE_BASE_KEY, CCACHE_*, CXX) to the
workflow-level env.
Remove dead ccache scaffolding:
- reusable-lint-py: the job never compiles or caches; drop its ccache env.
- reusable-rtlmeter-run: remove the disabled persistent-cache step and its
storage variables; keep CCACHE_DISABLE=1, since caching must stay off to
keep RTLMeter timings representative.
Store test job ccache as artifacts for reuse
2026-07-06 02:44:32 +02:00
|
|
|
ccache --evict-older-than "$((SECONDS - BUILD_START + 60))s"
|
|
|
|
|
ccache -svv
|