spiegel-keyman/resources/build/ci/trigger-builds.inc.sh
Eberhard Beilharz 612cd01743
maint(linux): allow to skip API check
This change adds an option to skip the API checks during a build.
This can be done by adding the trailer `Keyman-Api-Check: skip`
to the PR description.

Fixes: #10454
Test-bot: skip
Keyman-Api-Check: skip
2025-09-05 19:04:23 +02:00

192 lines
6.3 KiB
Bash

# shellcheck shell=bash
# Keyman is copyright (C) SIL Global. MIT License.
#
# Tell TeamCity to trigger new release builds
#
function triggerReleaseBuilds() {
local base=`git branch --show-current`
# convert stable-14.0 to stable_14_0 to fit in with the definitions
# in trigger-definitions.inc.sh
local bcbase=${base//[-.]/_}
eval TEAMCITY_VCS_ID='${'vcs_$bcbase'}'
echo "base=$base, TEAMCITY_VCS_ID=${TEAMCITY_VCS_ID}"
for platform in ${available_platforms[@]}; do
eval builds='(${'bc_${bcbase}_${platform}'[@]})'
for build in "${builds[@]}"; do
if [[ $build == "" ]]; then continue; fi
if [ "${build:(-7)}" == "_GitHub" ]; then
local job=${build%_GitHub}
echo "Triggering GitHub action release build (isTestBuild=false) (level=release) $job $base"
triggerGitHubActionsBuild false release "$job" "$base"
else
echo "Triggering TeamCity release build (isTestBuild=false) (level=release) $build $TEAMCITY_VCS_ID $base"
triggerTeamCityBuild false release $build $TEAMCITY_VCS_ID $base
fi
done
done
}
#
# Trigger a build on TeamCity
#
# Parameters:
# 1: isTestBuild: 'true' if this is for a PR branch or a test build
# for a primary branch; false is this is a release
# build for a primary branch (master/beta/stable-x.y)
# 2: buildLevel: 'skip' - don't run build;
# 'build' - run build and unit tests;
# 'release' - run build, unit tests, and deploy
# 3: TeamCity build configuration name
# 4: TeamCity VCS id, which is different for PR test configurations
# 5: branch name in git
#
function triggerTeamCityBuild() {
local isTestBuild="$1"
local buildLevel="$2"
local TEAMCITY_BUILDTYPE="$3"
local TEAMCITY_VCS_ID="$4"
local TEAMCITY_BRANCH_NAME="$5"
local TEAMCITY_SERVER=https://build.palaso.org
local commandProperties="<properties><property name='env.KEYMAN_BUILD_LEVEL' value='$buildLevel' /></properties>"
local commandLastChanges=
if ! $isTestBuild; then
local GIT_OID=`git rev-parse HEAD`
commandLastChanges="<lastChanges><change vcsRootInstance='$TEAMCITY_VCS_ID' locator='version:$GIT_OID'/></lastChanges>"
fi
local command="<build branchName='$TEAMCITY_BRANCH_NAME' defaultBranch='false'><buildType id='$TEAMCITY_BUILDTYPE' />$commandLastChanges$commandProperties</build>"
echo "TeamCity Build Command: $command"
# adjust indentation for output of curl
echo -n " "
call_curl "$TEAMCITY_SERVER/app/rest/buildQueue" \
--header "Authorization: Bearer $TEAMCITY_TOKEN" \
-X POST \
-H "Content-Type: application/xml" \
-H "Accept: application/json" \
-H "Origin: $TEAMCITY_SERVER" \
-d "$command"
echo
}
#
# Trigger a build on GitHub Actions
#
# Parameters:
# 1: 'true' if this is for a PR branch, otherwise 'false' (for master/beta/stable-x.y)
# 2: 'skip' - don't run build; 'build' - run build and unit tests; 'test' - run build, unit tests, and deploy
# 3: Action name
# 4: branch name in git
# 5: 'true' to skip API checks, 'false' to run them (optional, default 'false')
#
function triggerGitHubActionsBuild() {
local IS_TEST_BUILD="$1"
local BUILD_LEVEL="$2"
local GITHUB_ACTION="$3"
local GIT_BRANCH="$4"
local SKIP_API_CHECK="${5:-"false"}"
local GIT_BASE_BRANCH="${GIT_BRANCH}"
local GIT_USER="keyman-server"
local GIT_BUILD_SHA GIT_BASE_REF JSON
local GITHUB_SERVER=https://api.github.com/repos/keymanapp/keyman
if [[ "${action:-""}" == "commit" ]]; then
# This will only be true if we created and pushed a tag
GIT_BUILD_SHA="$(git rev-parse "refs/tags/release@${KEYMAN_VERSION_WITH_TAG}")"
GIT_BASE_REF="$(git rev-parse "${GIT_BUILD_SHA}^")"
GIT_EVENT_TYPE="${GITHUB_ACTION}: release@${KEYMAN_VERSION_WITH_TAG}"
elif [[ ${GIT_BRANCH} =~ ^[0-9]+$ ]]; then
# pull request
local JSON
JSON=$(call_curl "${GITHUB_SERVER}/pulls/${GIT_BRANCH}" --header "Authorization: token ${GITHUB_TOKEN}")
GIT_BUILD_SHA="$(echo "${JSON}" | ${JQ} -r '.head.sha')"
GIT_EVENT_TYPE="${GITHUB_ACTION}: PR #${GIT_BRANCH}"
GIT_USER="$(echo "${JSON}" | ${JQ} -r '.user.login')"
GIT_BASE_BRANCH="$(echo "${JSON}" | ${JQ} -r '.base.ref')"
GIT_BASE_REF="$(echo "${JSON}" | ${JQ} -r '.base.sha')"
GIT_BRANCH="PR-${GIT_BRANCH}"
else
# another branch: stable-x.y, beta, or master
GIT_BUILD_SHA="$(git rev-parse "refs/heads/${GIT_BRANCH}")"
GIT_BASE_REF="$(git rev-parse "${GIT_BUILD_SHA}^")"
GIT_EVENT_TYPE="${GITHUB_ACTION}: ${GIT_BRANCH}"
fi
local DATA="{
\"event_type\": \"${GIT_EVENT_TYPE}\", \
\"client_payload\": { \
\"buildSha\": \"${GIT_BUILD_SHA}\", \
\"branch\": \"${GIT_BRANCH}\", \
\"baseBranch\": \"${GIT_BASE_BRANCH}\", \
\"baseRef\": \"${GIT_BASE_REF}\", \
\"user\": \"${GIT_USER}\", \
\"isTestBuild\": \"${IS_TEST_BUILD}\", \
\"buildLevel\": \"${BUILD_LEVEL}\", \
\"skipApiCheck\": \"${SKIP_API_CHECK}\" \
}}"
echo "GitHub Action Data: ${DATA}"
if [[ "${GIT_BUILD_SHA}" == null ]]; then
echo "Invalid GIT_BUILD_SHA"
exit 1
fi
# adjust indentation for output of curl
echo -n " "
call_curl "${GITHUB_SERVER}/dispatches" \
--request POST \
--header "Accept: application/vnd.github+json" \
--header "Authorization: token ${GITHUB_TOKEN}" \
--data "${DATA}"
echo
}
#
# Error handling and reporting for curl + default parameters
# We cannot use --fail-with-body yet due to older curl versions
# on infrastructure
#
function call_curl() {
local url="$1"
shift
local curl_result
local http_code
local output_file
output_file=$(mktemp)
set +e
if [[ $# -gt 0 ]]; then
http_code=$(curl --silent --output "${output_file}" --no-progress-meter --write-out "%{http_code}" "$@" "${url}")
else
http_code=$(curl --silent --output "${output_file}" --no-progress-meter --write-out "%{http_code}" "${url}")
fi
curl_result=$?
if [[ ${curl_result} != 0 ]]; then
echo "curl call to '${url}' failed with code '${curl_result}'" >& 2
>&2 cat "${output_file}"
rm -f "${output_file}"
exit ${curl_result}
fi
if [[ ${http_code} -lt 200 || ${http_code} -gt 299 ]] ; then
echo "curl call to '${url}' failed with HTTP error code '${http_code}'" >& 2
>&2 cat "${output_file}"
rm -f "${output_file}"
exit 22
fi
set -e
cat "${output_file}"
rm -f "${output_file}"
}