Sync with 2.30.9
[git.git] / ci / lib.sh
blob890b0bdfd0e55dbcd63edae8b66f55db7acec61a
1 # Library of functions shared by all CI scripts
3 skip_branch_tip_with_tag () {
4 # Sometimes, a branch is pushed at the same time the tag that points
5 # at the same commit as the tip of the branch is pushed, and building
6 # both at the same time is a waste.
8 # When the build is triggered by a push to a tag, $CI_BRANCH will
9 # have that tagname, e.g. v2.14.0. Let's see if $CI_BRANCH is
10 # exactly at a tag, and if so, if it is different from $CI_BRANCH.
11 # That way, we can tell if we are building the tip of a branch that
12 # is tagged and we can skip the build because we won't be skipping a
13 # build of a tag.
15 if TAG=$(git describe --exact-match "$CI_BRANCH" 2>/dev/null) &&
16 test "$TAG" != "$CI_BRANCH"
17 then
18 echo "$(tput setaf 2)Tip of $CI_BRANCH is exactly at $TAG$(tput sgr0)"
19 exit 0
23 # Save some info about the current commit's tree, so we can skip the build
24 # job if we encounter the same tree again and can provide a useful info
25 # message.
26 save_good_tree () {
27 echo "$(git rev-parse $CI_COMMIT^{tree}) $CI_COMMIT $CI_JOB_NUMBER $CI_JOB_ID" >>"$good_trees_file"
28 # limit the file size
29 tail -1000 "$good_trees_file" >"$good_trees_file".tmp
30 mv "$good_trees_file".tmp "$good_trees_file"
33 # Skip the build job if the same tree has already been built and tested
34 # successfully before (e.g. because the branch got rebased, changing only
35 # the commit messages).
36 skip_good_tree () {
37 if test "$TRAVIS_DEBUG_MODE" = true || test true = "$GITHUB_ACTIONS"
38 then
39 return
42 if ! good_tree_info="$(grep "^$(git rev-parse $CI_COMMIT^{tree}) " "$good_trees_file")"
43 then
44 # Haven't seen this tree yet, or no cached good trees file yet.
45 # Continue the build job.
46 return
49 echo "$good_tree_info" | {
50 read tree prev_good_commit prev_good_job_number prev_good_job_id
52 if test "$CI_JOB_ID" = "$prev_good_job_id"
53 then
54 cat <<-EOF
55 $(tput setaf 2)Skipping build job for commit $CI_COMMIT.$(tput sgr0)
56 This commit has already been built and tested successfully by this build job.
57 To force a re-build delete the branch's cache and then hit 'Restart job'.
58 EOF
59 else
60 cat <<-EOF
61 $(tput setaf 2)Skipping build job for commit $CI_COMMIT.$(tput sgr0)
62 This commit's tree has already been built and tested successfully in build job $prev_good_job_number for commit $prev_good_commit.
63 The log of that build job is available at $(url_for_job_id $prev_good_job_id)
64 To force a re-build delete the branch's cache and then hit 'Restart job'.
65 EOF
69 exit 0
72 check_unignored_build_artifacts ()
74 ! git ls-files --other --exclude-standard --error-unmatch \
75 -- ':/*' 2>/dev/null ||
77 echo "$(tput setaf 1)error: found unignored build artifacts$(tput sgr0)"
78 false
82 # GitHub Action doesn't set TERM, which is required by tput
83 export TERM=${TERM:-dumb}
85 # Clear MAKEFLAGS that may come from the outside world.
86 export MAKEFLAGS=
88 # Set 'exit on error' for all CI scripts to let the caller know that
89 # something went wrong.
90 # Set tracing executed commands, primarily setting environment variables
91 # and installing dependencies.
92 set -ex
94 if test true = "$TRAVIS"
95 then
96 CI_TYPE=travis
97 # When building a PR, TRAVIS_BRANCH refers to the *target* branch. Not
98 # what we want here. We want the source branch instead.
99 CI_BRANCH="${TRAVIS_PULL_REQUEST_BRANCH:-$TRAVIS_BRANCH}"
100 CI_COMMIT="$TRAVIS_COMMIT"
101 CI_JOB_ID="$TRAVIS_JOB_ID"
102 CI_JOB_NUMBER="$TRAVIS_JOB_NUMBER"
103 CI_OS_NAME="$TRAVIS_OS_NAME"
104 CI_REPO_SLUG="$TRAVIS_REPO_SLUG"
106 cache_dir="$HOME/travis-cache"
108 url_for_job_id () {
109 echo "https://travis-ci.org/$CI_REPO_SLUG/jobs/$1"
112 BREW_INSTALL_PACKAGES="git-lfs gettext"
113 export GIT_PROVE_OPTS="--timer --jobs 3 --state=failed,slow,save"
114 export GIT_TEST_OPTS="--verbose-log -x --immediate"
115 MAKEFLAGS="$MAKEFLAGS --jobs=2"
116 elif test -n "$SYSTEM_COLLECTIONURI" || test -n "$SYSTEM_TASKDEFINITIONSURI"
117 then
118 CI_TYPE=azure-pipelines
119 # We are running in Azure Pipelines
120 CI_BRANCH="$BUILD_SOURCEBRANCH"
121 CI_COMMIT="$BUILD_SOURCEVERSION"
122 CI_JOB_ID="$BUILD_BUILDID"
123 CI_JOB_NUMBER="$BUILD_BUILDNUMBER"
124 CI_OS_NAME="$(echo "$AGENT_OS" | tr A-Z a-z)"
125 test darwin != "$CI_OS_NAME" || CI_OS_NAME=osx
126 CI_REPO_SLUG="$(expr "$BUILD_REPOSITORY_URI" : '.*/\([^/]*/[^/]*\)$')"
127 CC="${CC:-gcc}"
129 # use a subdirectory of the cache dir (because the file share is shared
130 # among *all* phases)
131 cache_dir="$HOME/test-cache/$SYSTEM_PHASENAME"
133 url_for_job_id () {
134 echo "$SYSTEM_TASKDEFINITIONSURI$SYSTEM_TEAMPROJECT/_build/results?buildId=$1"
137 export GIT_PROVE_OPTS="--timer --jobs 10 --state=failed,slow,save"
138 export GIT_TEST_OPTS="--verbose-log -x --write-junit-xml"
139 MAKEFLAGS="$MAKEFLAGS --jobs=10"
140 test windows_nt != "$CI_OS_NAME" ||
141 GIT_TEST_OPTS="--no-chain-lint --no-bin-wrappers $GIT_TEST_OPTS"
142 elif test true = "$GITHUB_ACTIONS"
143 then
144 CI_TYPE=github-actions
145 CI_BRANCH="$GITHUB_REF"
146 CI_COMMIT="$GITHUB_SHA"
147 CI_OS_NAME="$(echo "$RUNNER_OS" | tr A-Z a-z)"
148 test macos != "$CI_OS_NAME" || CI_OS_NAME=osx
149 CI_REPO_SLUG="$GITHUB_REPOSITORY"
150 CI_JOB_ID="$GITHUB_RUN_ID"
151 CC="${CC:-gcc}"
152 DONT_SKIP_TAGS=t
154 cache_dir="$HOME/none"
156 export GIT_PROVE_OPTS="--timer --jobs 10"
157 export GIT_TEST_OPTS="--verbose-log -x"
158 MAKEFLAGS="$MAKEFLAGS --jobs=10"
159 test windows != "$CI_OS_NAME" ||
160 GIT_TEST_OPTS="--no-chain-lint --no-bin-wrappers $GIT_TEST_OPTS"
161 else
162 echo "Could not identify CI type" >&2
163 env >&2
164 exit 1
167 good_trees_file="$cache_dir/good-trees"
169 mkdir -p "$cache_dir"
171 test -n "${DONT_SKIP_TAGS-}" ||
172 skip_branch_tip_with_tag
173 skip_good_tree
175 if test -z "$jobname"
176 then
177 jobname="$CI_OS_NAME-$CC"
180 export DEVELOPER=1
181 export DEFAULT_TEST_TARGET=prove
182 export GIT_TEST_CLONE_2GB=true
183 export SKIP_DASHED_BUILT_INS=YesPlease
185 case "$jobname" in
186 linux-clang|linux-gcc)
187 PYTHON_PACKAGE=python2
188 if [ "$jobname" = linux-gcc ]
189 then
190 export CC=gcc-8
191 PYTHON_PACKAGE=python3
193 MAKEFLAGS="$MAKEFLAGS PYTHON_PATH=/usr/bin/$PYTHON_PACKAGE"
195 export GIT_TEST_HTTPD=true
197 # The Linux build installs the defined dependency versions below.
198 # The OS X build installs much more recent versions, whichever
199 # were recorded in the Homebrew database upon creating the OS X
200 # image.
201 # Keep that in mind when you encounter a broken OS X build!
202 export LINUX_GIT_LFS_VERSION="1.5.2"
204 P4_PATH="$HOME/custom/p4"
205 GIT_LFS_PATH="$HOME/custom/git-lfs"
206 export PATH="$GIT_LFS_PATH:$P4_PATH:$PATH"
208 osx-clang|osx-gcc)
209 if [ "$jobname" = osx-gcc ]
210 then
211 export CC=gcc-9
212 MAKEFLAGS="$MAKEFLAGS PYTHON_PATH=$(which python3)"
213 else
214 MAKEFLAGS="$MAKEFLAGS PYTHON_PATH=$(which python2)"
217 # t9810 occasionally fails on Travis CI OS X
218 # t9816 occasionally fails with "TAP out of sequence errors" on
219 # Travis CI OS X
220 export GIT_SKIP_TESTS="t9810 t9816"
222 linux-gcc-default)
224 Linux32)
225 CC=gcc
227 linux-musl)
228 CC=gcc
229 MAKEFLAGS="$MAKEFLAGS PYTHON_PATH=/usr/bin/python3 USE_LIBPCRE2=Yes"
230 MAKEFLAGS="$MAKEFLAGS NO_REGEX=Yes ICONV_OMITS_BOM=Yes"
232 esac
234 MAKEFLAGS="$MAKEFLAGS CC=${CC:-cc}"