2 # SPDX-License-Identifier: EPL-1.0
3 ##############################################################################
4 # Copyright (c) 2019 The Linux Foundation and others.
6 # All rights reserved. This program and the accompanying materials
7 # are made available under the terms of the Eclipse Public License v1.0
8 # which accompanies this distribution, and is available at
9 # http://www.eclipse.org/legal/epl-v10.html
10 ##############################################################################
11 echo "---> release-job.sh"
14 # shellcheck disable=SC1090
17 # Version controlled by JJB_VERSION
18 lf-activate-venv lftools pip idna==2.9 lftools jsonschema twine yq readline
20 # show installed versions
21 python -m pip --version
26 set_variables_common(){
27 echo "INFO: Setting common variables"
28 if [[ -z ${LOGS_SERVER:-} ]] || [[ -z ${CDN_URL:-} ]]; then
29 echo "ERROR: LOGS_SERVER or CDN_URL not defined"
32 NEXUS_PATH="${SILO}/${JENKINS_HOSTNAME}/"
33 # Verify if using release file or parameters
34 if $USE_RELEASE_FILE ; then
35 release_files=$(git diff-tree -m --no-commit-id -r "$GIT_COMMIT" "$GIT_COMMIT^1" \
36 --name-only -- "releases/" ".releases/")
37 if (( $(grep -c . <<<"$release_files") > 1 )); then
38 echo "INFO: RELEASE FILES ARE AS FOLLOWS: $release_files"
39 echo "ERROR: Adding multiple release files in the same commit"
40 echo "ERROR: OR rename/amend/delete of existing files is not supported."
43 release_file="$release_files"
44 echo "INFO: RELEASE FILE: $release_files"
47 echo "INFO: This job is built with parameters, no release file needed."
51 if [[ -n ${LOGS_SERVER:-} ]]; then
52 logs_url="${LOGS_SERVER}/${NEXUS_PATH}${LOG_DIR}"
53 elif [[ -n ${CDN_URL:-} ]]; then
54 logs_url="https://${CDN_URL:-}/logs/${NEXUS_PATH}${LOG_DIR}"
56 logs_url=${logs_url%/} # strip any trailing '/'
58 # Jenkins parameter drop-down defaults DISTRIBUTION_TYPE to None
59 # in the contain/maven release job; get value from release yaml.
60 # Packagecloud and PyPI jobs set the appropriate value.
61 DISTRIBUTION_TYPE="${DISTRIBUTION_TYPE:-None}"
62 if [[ $DISTRIBUTION_TYPE == "None" ]]; then
63 if ! DISTRIBUTION_TYPE=$(yq -r ".distribution_type" "$release_file"); then
64 echo "ERROR: Failed to get distribution_type from $release_file"
69 PATCH_DIR=$(mktemp -d)
71 TAG_RELEASE="${TAG_RELEASE:-None}"
72 if [[ $TAG_RELEASE == "None" ]]; then
73 if grep -q "tag_release" $release_file ; then
74 TAG_RELEASE=$(yq -r .tag_release "$release_file")
80 # Displaying Release Information (Common variables)
81 printf "\t%-30s\n" RELEASE_ENVIRONMENT_INFO:
82 printf "\t%-30s %s\n" RELEASE_FILE: "$release_file"
83 printf "\t%-30s %s\n" LOGS_SERVER: "$LOGS_SERVER"
84 printf "\t%-30s %s\n" CDN_URL: "${CDN_URL:-None}"
85 printf "\t%-30s %s\n" NEXUS_PATH: "$NEXUS_PATH"
86 printf "\t%-30s %s\n" JENKINS_HOSTNAME: "$JENKINS_HOSTNAME"
87 printf "\t%-30s %s\n" SILO: "$SILO"
88 printf "\t%-30s %s\n" PROJECT: "$PROJECT"
89 printf "\t%-30s %s\n" PROJECT-DASHED: "${PROJECT//\//-}"
90 printf "\t%-30s %s\n" TAG_RELEASE: "$TAG_RELEASE"
91 printf "\t%-30s %s\n" DISTRIBUTION_TYPE: "$DISTRIBUTION_TYPE"
92 printf "\t%-30s %s\n" OVERRIDE_SEMVER_REGEX: "${OVERRIDE_SEMVER_REGEX:-None}"
95 set_variables_maven(){
96 echo "INFO: Setting maven variables"
97 if [[ -z ${VERSION:-} ]]; then
98 VERSION=$(yq -r ".version" "$release_file")
100 if [[ -z ${GIT_TAG:-} ]]; then
101 if grep -q "git_tag" "$release_file" ; then
102 GIT_TAG=$(yq -r ".git_tag" "$release_file")
107 if [[ -z ${LOG_DIR:-} ]]; then
108 LOG_DIR=$(yq -r ".log_dir" "$release_file")
111 # Continuing displaying Release Information (Maven)
112 printf "\t%-30s\n" RELEASE_MAVEN_INFO:
113 printf "\t%-30s %s\n" VERSION: "$VERSION"
114 printf "\t%-30s %s\n" GIT_TAG: "$GIT_TAG"
115 printf "\t%-30s %s\n" LOG_DIR: "$LOG_DIR"
116 printf "\t%-30s %s\n" LOGS_URL: "$logs_url"
119 set_variables_container(){
120 echo "INFO: Setting container variables"
121 if [[ -z ${VERSION:-} ]]; then
122 VERSION=$(yq -r ".container_release_tag" "$release_file")
124 if [[ -z ${GIT_TAG:-} ]]; then
125 if grep -q "git_tag" "$release_file" ; then
126 GIT_TAG=$(yq -r ".git_tag" "$release_file")
131 if grep -q "container_pull_registry" "$release_file" ; then
132 CONTAINER_PULL_REGISTRY=$(yq -r ".container_pull_registry" "$release_file")
134 if grep -q "container_push_registry" "$release_file" ; then
135 CONTAINER_PUSH_REGISTRY=$(yq -r ".container_push_registry" "$release_file")
137 # Make sure both pull and push registries are defined
138 if [ -z ${CONTAINER_PULL_REGISTRY+x} ] || [ -z ${CONTAINER_PUSH_REGISTRY+x} ]; then
139 echo "ERROR: CONTAINER_PULL_REGISTRY and CONTAINER_PUSH_REGISTRY need to be defined"
142 ref=$(yq -r ".ref" "$release_file")
144 # Continuing displaying Release Information (Container)
145 printf "\t%-30s\n" RELEASE_CONTAINER_INFO:
146 printf "\t%-30s %s\n" CONTAINER_RELEASE_TAG: "$VERSION"
147 printf "\t%-30s %s\n" CONTAINER_PULL_REGISTRY: "$CONTAINER_PULL_REGISTRY"
148 printf "\t%-30s %s\n" CONTAINER_PUSH_REGISTRY: "$CONTAINER_PUSH_REGISTRY"
149 printf "\t%-30s %s\n" GERRIT_REF_TO_TAG: "$ref"
150 printf "\t%-30s %s\n" GIT_TAG: "$GIT_TAG"
153 set_variables_pypi(){
154 echo "INFO: Setting pypi variables"
155 if [[ -z ${LOG_DIR:-} ]]; then
156 LOG_DIR=$(yq -r ".log_dir" "$release_file")
159 if [[ -z ${PYPI_PROJECT:-} ]]; then
160 PYPI_PROJECT=$(yq -r ".pypi_project" "$release_file")
162 if [[ -z ${PYTHON_VERSION:-} ]]; then
163 PYTHON_VERSION=$(yq -r ".python_version" "$release_file")
165 if [[ -z ${VERSION:-} ]]; then
166 VERSION=$(yq -r ".version" "$release_file")
168 if [[ -z ${GIT_TAG:-} ]]; then
169 if grep -q "git_tag" "$release_file" ; then
170 GIT_TAG=$(yq -r ".git_tag" "$release_file")
176 # Continuing displaying Release Information (pypi)
177 printf "\t%-30s\n" RELEASE_PYPI_INFO:
178 printf "\t%-30s %s\n" LOG_DIR: "$LOG_DIR"
179 printf "\t%-30s %s\n" LOGS_URL: "$logs_url"
180 printf "\t%-30s %s\n" PYPI_INDEX: "$PYPI_INDEX" # from job configuration
181 printf "\t%-30s %s\n" PYPI_PROJECT: "$PYPI_PROJECT"
182 printf "\t%-30s %s\n" PYTHON_VERSION: "$PYTHON_VERSION"
183 printf "\t%-30s %s\n" VERSION: "$VERSION"
184 printf "\t%-30s %s\n" GIT_TAG: "$GIT_TAG"
187 set_variables_packagecloud(){
188 echo "INFO: Setting packagecloud variables"
189 if [[ -z ${VERSION:-} ]]; then
190 VERSION=$(yq -r ".version" "$release_file")
192 if [[ -z ${GIT_TAG:-} ]]; then
193 if grep -q "git_tag" $release_file ; then
194 GIT_TAG=$(yq -r ".git_tag" "$release_file")
199 if [[ -z ${LOG_DIR:-} ]]; then
200 LOG_DIR=$(yq -r ".log_dir" "$release_file")
202 if [[ -z ${REF:-} ]]; then
203 REF=$(yq -r ".ref" "$release_file")
205 if [[ -z ${PACKAGE_NAME:-} ]]; then
206 PACKAGE_NAME=$(yq -r ".package_name" "$release_file")
209 printf "\t%-30s %s\n" PACKAGE_NAME: "$PACKAGE_NAME"
210 printf "\t%-30s %s\n" LOG_DIR: "$LOG_DIR"
211 printf "\t%-30s %s\n" LOGS_URL: "$logs_url"
212 printf "\t%-30s %s\n" GERRIT_REF_TO_TAG: "$REF"
213 printf "\t%-30s %s\n" VERSION: "$VERSION"
214 printf "\t%-30s %s\n" GIT_TAG: "$GIT_TAG"
218 echo "INFO: Verifying $release_file against schema $release_schema"
219 lftools schema verify "$release_file" "$release_schema"
224 # Override the regex for projects that do not follow https://semver.org
225 OVERRIDE_SEMVER_REGEX="${OVERRIDE_SEMVER_REGEX:-None}"
226 if [[ $OVERRIDE_SEMVER_REGEX == "None" ]]; then
227 # Use the semver regex taken from https://github.com/fsaintjacques/semver-tool
228 semver_regex="^[vV]?(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(\-(0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*)(\.(0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*))*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$"
230 semver_regex="${OVERRIDE_SEMVER_REGEX}"
233 # Verify SemVer "#.#.#" (SemVer) or "v#.#.#"
234 echo "INFO: Verifying version $VERSION"
235 if [[ $VERSION =~ $semver_regex ]]; then
236 echo "INFO: The version $VERSION is valid"
238 echo "ERROR: The version $VERSION is not valid"
239 echo "ERROR: Valid versions are \"#.#.#\" (SemVer) or \"v#.#.#\""
240 echo "ERROR: Valid version will be matched against \"${semver_regex}\""
241 echo "ERROR: Refer to https://semver.org/ for more details on SemVer"
242 echo "ERROR: Refer SemVer examples from https://github.com/fsaintjacques/semver-tool/#examples"
247 verify_version_match_release(){
248 echo "INFO: Fetching console log from $logs_url"
249 wget -P /tmp "${logs_url}/"console.log.gz
250 echo "INFO: Searching for uploaded step and version $VERSION in job log"
251 if zgrep "Successfully uploaded" /tmp/console.log.gz | grep "$VERSION"; then
252 echo "INFO: found expected strings in job log"
254 echo "ERROR: Defined version in release file does not match staging repo artifacts version to be released"
255 echo "ERROR: Please make sure maven stage job log dir and release version are both correct"
260 # check prerequisites to detect mistakes in the release YAML file
261 verify_pypi_match_release(){
262 echo "INFO: Fetching console log from $logs_url"
263 wget -q -P /tmp "${logs_url}/"console.log.gz
264 echo "INFO: Searching for uploaded step, project $PYPI_PROJECT and version $VERSION in job log"
265 # pypi-upload.sh generates success message with file list
266 if zgrep -i "uploaded" /tmp/console.log.gz | grep "$PYPI_PROJECT" | grep "$VERSION" ; then
267 echo "INFO: found expected strings in job log"
269 echo "ERROR: failed to find expected strings in job log"
274 verify_packagecloud_match_release(){
275 echo "INFO: Fetching console log from $logs_url"
276 wget -q -P /tmp "${logs_url}/"console.log.gz
277 echo "INFO: Searching for uploaded step, package name $PACKAGE_NAME and version $VERSION in job log"
278 if zgrep -E "Pushing.*$PACKAGE_NAME.*$VERSION.*success\!" /tmp/console.log.gz; then
279 echo "INFO: found expected strings in job log"
281 echo "ERROR: failed to find expected strings in job log"
286 # sigul is only available on Centos
287 # TODO: write tag-github-repo function
289 if [[ $TAG_RELEASE == false ]]; then
290 echo "INFO: Skipping gerrit repo tag"
294 echo "INFO: tag gerrit with $GIT_TAG"
295 # Import public signing key
296 gpg --import "$SIGNING_PUBKEY"
297 if type=$(git cat-file -t "$GIT_TAG"); then
298 if [[ $type == "tag" ]]; then
299 echo "INFO: Repo already has signed tag $GIT_TAG, nothing to do"
301 echo "ERROR: Repo has lightweight tag $GIT_TAG, blocks push of signed tag"
305 echo "INFO: Repo has not yet been tagged $GIT_TAG"
306 git tag -am "${PROJECT//\//-} $GIT_TAG" "$GIT_TAG"
307 sigul --batch -c "$SIGUL_CONFIG" sign-git-tag "$SIGUL_KEY" "$GIT_TAG" < "$SIGUL_PASSWORD"
308 echo "INFO: Showing latest signature for $PROJECT:"
309 echo "INFO: git tag -v $GIT_TAG"
310 git tag -v "$GIT_TAG"
312 ########## Merge Part ##############
313 if [[ "$JOB_NAME" =~ "merge" ]] && [[ "$DRY_RUN" = false ]]; then
314 echo "INFO: Running merge, pushing tag"
315 gerrit_ssh=$(echo "$GERRIT_URL" | awk -F"/" '{print $3}')
316 git remote set-url origin ssh://"$RELEASE_USERNAME"@"$gerrit_ssh":29418/"$PROJECT"
317 git config user.name "$RELEASE_USERNAME"
318 git config user.email "$RELEASE_EMAIL"
319 echo -e "Host $gerrit_ssh\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
320 chmod 600 ~/.ssh/config
321 git push origin "$GIT_TAG"
327 echo "INFO: Processing nexus release"
328 for staging_url in $(zcat "$PATCH_DIR"/staging-repo.txt.gz | awk -e '{print $2}'); do
329 # extract the domain name from URL
330 NEXUS_URL=$(echo "$staging_url" | sed -e 's|^[^/]*//||' -e 's|/.*$||')
331 echo "INFO: NEXUS_URL: $NEXUS_URL"
332 # extract the staging repo from URL
333 STAGING_REPO=${staging_url#*repositories/}
334 echo "INFO: Running Nexus Verify"
335 lftools nexus release -v --server https://"$NEXUS_URL" "$STAGING_REPO"
336 echo "INFO: Merge will run:"
337 echo "lftools nexus release --server https://$NEXUS_URL $STAGING_REPO"
340 #Run the loop twice, to catch errors on either nexus repo
341 if [[ "$JOB_NAME" =~ "merge" ]] && [[ "$DRY_RUN" = false ]]; then
342 for staging_url in $(zcat "$PATCH_DIR"/staging-repo.txt.gz | awk -e '{print $2}'); do
343 NEXUS_URL=$(echo "$staging_url" | sed -e 's|^[^/]*//||' -e 's|/.*$||')
344 STAGING_REPO=${staging_url#*repositories/}
345 echo "INFO: Promoting $STAGING_REPO on $NEXUS_URL."
346 lftools nexus release --server https://"$NEXUS_URL" "$STAGING_REPO"
351 container_release_file(){
352 echo "INFO: Processing container release"
355 lfn_umbrella="$(echo "$GERRIT_URL" | awk -F"." '{print $2}')"
357 for namequoted in $(yq '.containers[].name' $release_file); do
358 versionquoted=$(yq ".containers[] |select(.name==$namequoted) |.version" $release_file)
360 #Remove extra yaml quotes
361 name="${namequoted#\"}"
363 version="${versionquoted#\"}"
364 version="${version%\"}"
368 echo "INFO: Merge will release $name $version as $VERSION"
369 # Attempt to pull from releases registry to see if the image has been released.
370 if docker pull "$CONTAINER_PUSH_REGISTRY"/"$lfn_umbrella"/"$name":"$VERSION"; then
371 echo "INFO: $VERSION is already released for image $name, Continuing..."
373 echo "INFO: $VERSION not found in releases, release will be prepared. Continuing..."
374 docker pull "$CONTAINER_PULL_REGISTRY"/"$lfn_umbrella"/"$name":"$version"
375 container_image_id=$(docker images | grep "$name" | grep "$version" | awk '{print $3}')
376 echo "INFO: Merge will run the following commands:"
377 echo "docker tag $container_image_id $CONTAINER_PUSH_REGISTRY/$lfn_umbrella/$name:$VERSION"
378 echo "docker push $CONTAINER_PUSH_REGISTRY/$lfn_umbrella/$name:$VERSION"
379 if [[ "$JOB_NAME" =~ "merge" ]]; then
380 docker tag "$container_image_id" "$CONTAINER_PUSH_REGISTRY"/"$lfn_umbrella"/"$name":"$VERSION"
381 docker push "$CONTAINER_PUSH_REGISTRY"/"$lfn_umbrella"/"$name":"$VERSION"
383 echo "#########################"
387 echo "INFO: Merge will tag ref: $ref"
392 maven_release_file(){
393 echo "INFO: Processing maven release"
394 echo "INFO: wget -P $PATCH_DIR ${logs_url}/staging-repo.txt.gz"
395 wget -P "$PATCH_DIR" "${logs_url}/"staging-repo.txt.gz
397 echo "INFO: wget ${logs_url}/patches/{${PROJECT//\//-}.bundle,taglist.log.gz}"
398 wget "${logs_url}"/patches/{"${PROJECT//\//-}".bundle,taglist.log.gz}
399 gunzip taglist.log.gz
400 cat "$PATCH_DIR"/taglist.log
402 git checkout "$(awk '{print $NF}' "$PATCH_DIR/taglist.log")"
403 git fetch "$PATCH_DIR/${PROJECT//\//-}.bundle"
404 git merge --ff-only FETCH_HEAD
409 # calls pip to download binary and source distributions from the specified index,
410 # which requires a recent-in-2019 version. Uploads the files it received.
412 echo "INFO: Processing pypi release"
415 pip_pfx="pip download -d $tgtdir --no-deps --python-version $PYTHON_VERSION -i $PYPI_INDEX"
416 module="$PYPI_PROJECT==$VERSION"
417 pip_bin="$pip_pfx $module"
418 echo "INFO: downloading binary: $pip_bin"
420 echo "WARN: failed to download binary distribution"
422 pip_src="$pip_pfx --no-binary=:all: $module"
423 echo "INFO: downloading source: $pip_src"
425 echo "WARN: failed to download source distribution"
427 echo "INFO: Checking files in $tgtdir"
428 # shellcheck disable=SC2012
429 filecount=$(ls $tgtdir | wc -l)
430 if [[ $filecount = 0 ]] ; then
431 echo "ERROR: no files downloaded"
434 # shellcheck disable=SC2046
435 echo "INFO: downloaded $filecount distributions: " $(ls $tgtdir)
438 if [[ ! "$JOB_NAME" =~ "merge" ]] ; then
439 echo "INFO: not a merge job, not uploading files"
443 cmd="twine upload -r $REPOSITORY $tgtdir/*"
445 echo "INFO: dry-run is set, echoing command only"
448 echo "INFO: uploading $filecount distributions to repo $REPOSITORY"
454 packagecloud_verify(){
455 echo "INFO: Verifying $1 exists in staging..."
456 if [[ $1 == $(curl --netrc-file ~/packagecloud_api --silent \
457 https://packagecloud.io/api/v1/repos/"$2"/staging/search?q="$1" \
458 | yq -r .[].filename) ]]; then
459 echo "INFO: $1 exists in staging!"
460 echo "INFO: Existing package location: https://packagecloud.io$(curl \
461 --netrc-file ~/packagecloud_api --silent \
462 https://packagecloud.io/api/v1/repos/"$2"/staging/search?q="$1" \
463 | yq -r .[].package_html_url)"
465 echo "ERROR: $1 does not exist in staging"
470 packagecloud_promote(){
471 echo "INFO: Preparing to promote $1..."
472 promote_url="https://packagecloud.io$(curl --netrc-file ~/packagecloud_api \
473 --silent https://packagecloud.io/api/v1/repos/"$2"/staging/search?q="$1" \
474 | yq -r .[].promote_url)"
475 echo "INFO: Promoting $1 from staging to release"
476 curl --netrc-file ~/packagecloud_api -X POST -F \
477 destination="$2/release" "$promote_url" \
478 | echo "INFO: Promoted package location: \
479 https://packagecloud.io$(yq -r .package_html_url)"
484 ############################## End Function Declarations ################################
486 # Set common environment variables
489 # Determine the type of release:
490 # - container, release-container-schema.yaml
491 # - maven, release-schema.yaml
492 # - pypi, release-pypi-schema.yaml
494 case $DISTRIBUTION_TYPE in
497 if $USE_RELEASE_FILE ; then
498 release_schema="release-schema.yaml"
499 echo "INFO: Fetching schema $release_schema"
500 wget -q https://raw.githubusercontent.com/lfit/releng-global-jjb/master/schema/$release_schema
505 verify_version_match_release
510 if $USE_RELEASE_FILE ; then
511 release_schema="release-container-schema.yaml"
512 echo "INFO: Fetching schema $release_schema"
513 wget -q https://raw.githubusercontent.com/lfit/releng-global-jjb/master/schema/${release_schema}
516 set_variables_container
518 container_release_file
522 if $USE_RELEASE_FILE ; then
523 release_schema="release-pypi-schema.yaml"
524 echo "INFO: Fetching schema $release_schema"
525 wget -q https://raw.githubusercontent.com/lfit/releng-global-jjb/master/schema/${release_schema}
530 verify_pypi_match_release
535 if $USE_RELEASE_FILE ; then
536 release_schema="release-packagecloud-schema.yaml"
537 packagecloud_account=$(cat "$ACCOUNT_NAME_FILE")
538 echo "INFO: Fetching schema $release_schema"
539 wget -q https://raw.githubusercontent.com/lfit/releng-global-jjb/master/schema/${release_schema}
542 set_variables_packagecloud
543 verify_packagecloud_match_release
544 for name in $(yq -r '.packages[].name' $release_file); do
546 packagecloud_verify "$package" "$packagecloud_account"
547 if [[ "$JOB_NAME" =~ "merge" ]] && ! $DRY_RUN; then
548 packagecloud_promote "$package" "$packagecloud_account"
554 echo "ERROR: distribution_type: $DISTRIBUTION_TYPE not supported"
559 echo "---> release-job.sh ends"