blob: 7397d1e795d8142091ae3bfbd1a48b2a2f21212d [file] [log] [blame]
#!/usr/bin/env bash
# -----------------------------------------------------------------------
# Copyright 2018-2023 Open Networking Foundation (ONF) and the ONF Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# github-release.sh
# builds (with make) and uploads release artifacts (binaries, etc.) to github
# given a tag also create checksums files and release notes from the commit
# message
# -----------------------------------------------------------------------
# 1) Staging to replace command github-release with gh.
# 2) gh auth / GIT_TOKEN handling may be needed
# -----------------------------------------------------------------------
# gh release create abc/1.2.3-rc2 --discussion-category "Announcements" --generate-notes hello.txt
# https://github.com/cli/cli/issues/4993
# -----------------------------------------------------------------------
# declare -g TRACE=0 # uncomment to set -x
# shellcheck disable=SC2015
[[ -v TRACE ]] && { set -x; } || { set +x; } # SC2015 (shellcheck -x)
##-------------------##
##---] GLOBALS [---##
##-------------------##
set -euo pipefail
declare -g scratch # temp workspace for downloads
declare -g gh_cmd # path to gh command
declare -g ARGV="$*" # archive for display
declare -g SCRIPT_VERSION='1.1' # git changeset needed
declare -g RELEASE_TEMP
##--------------------##
##---] INCLUDES [---##
##--------------------#
# shellcheck disable=SC1091
# source "${pgmdir}/common/common.sh" "${common_args[@]}"
## -----------------------------------------------------------------------
## Intent: Cleanup scratch area on exit
## -----------------------------------------------------------------------
function sigtrap()
{
## Prevent mishaps
local is_read_only
is_read_only="$(declare -p scratch)"
if [[ $is_read_only != *"declare -r scratch="* ]]; then
echo "ERROR: variable scratch is not read-only, cleanup skipped"
exit 1
fi
if [ -d "$scratch" ]; then
/bin/rm -fr "$scratch"
fi
return
}
trap sigtrap EXIT
## -----------------------------------------------------------------------
## Intent: Create a scratch area for downloads and transient tools
## -----------------------------------------------------------------------
function init()
{
declare -g scratch
local pkgbase="${0##*/}" # basename
local pkgname="${pkgbase%.*}"
scratch="$(mktemp -d -t "${pkgname}.XXXXXXXXXX")"
readonly scratch
return
}
## -----------------------------------------------------------------------
## Intent: Output a log banner to identify the running script/version.
## -----------------------------------------------------------------------
## TODO:
## o SCRIPT_VERSION => git changeset for repo:ci-managment
## o echo "library version: ${env."library.libName.version"}"
# -----------------------------------------------------------------------
# 14:18:38 > git fetch --no-tags --progress -- https://gerrit.opencord.org/ci-management.git +refs/heads/*:refs/remotes/origin/* # timeout=10
# 14:18:39 Checking out Revision 50f6e0b97f449b32d32ec0e02d59642000351847 (master)
# -----------------------------------------------------------------------
function banner()
{
local iam="${0##*/}"
cat <<EOH
** -----------------------------------------------------------------------
** IAM: ${iam} :: ${FUNCNAME[0]}
** ARGV: ${ARGV}
** PWD: $(/bin/pwd)
** NOW: $(date '+%Y/%m/%d %H:%M:%S')
** VER: ${SCRIPT_VERSION:-'unknown'}
** -----------------------------------------------------------------------
EOH
return
}
## -----------------------------------------------------------------------
## Intent:
## Display available command versions
## A github release job is failing due to a command being mia.
## -----------------------------------------------------------------------
function displayCommands()
{
# which git || /bin/true
# git --version || /bin/true
# go version || /bin/true
# helm version || /bin/true
return
}
## -----------------------------------------------------------------------
## Intent: Display filesystem with a banner for logging
## -----------------------------------------------------------------------
function displayPwd()
{
local iam="${0##*/}"
echo "** ${iam}: ENTER"
cat <<EOM
** -----------------------------------------------------------------------
** IAM: $iam :: ${FUNCNAME[0]}
** PWD: $(/bin/pwd)
** -----------------------------------------------------------------------
EOM
find . -maxdepth 1 -ls
echo "** ${iam}: LEAVE"
return
}
## -----------------------------------------------------------------------
## Intent: Copy files from the build directory into the release staging directory.
## -----------------------------------------------------------------------
function copyToRelease()
{
local iam="${FUNCNAME[0]}"
echo "** ${iam}: ENTER"
local artifact_glob="${ARTIFACT_GLOB%/*}"
echo "** ${iam}: $(declare -p ARTIFACT_GLOB) $(declare -p artifact_glob)"
# Copy artifacts into the release temp dir
# shellcheck disable=SC2086
# cp -v "$ARTIFACT_GLOB" "$RELEASE_TEMP"
echo "rsync -rv --checksum \"$artifact_glob/.\" \"$RELEASE_TEMP/.\""
rsync -rv --checksum "$artifact_glob/." "$RELEASE_TEMP/."
echo "** ${iam}: RELEASE_TEMP=${RELEASE_TEMP}"
find "$RELEASE_TEMP" -print
echo "** ${iam}: LEAVE"
echo
return
}
## -----------------------------------------------------------------------
## Intent:
## -----------------------------------------------------------------------
function github_release_list()
{
local what="$1" ; shift
local user="$1" ; shift
local repo="$1" ; shift
local iam="${FUNCNAME[0]}"
echo "** ${iam}: ENTER"
declare -a cmd=()
cmd+=("$gh_cmd")
cmd+=('--verbose')
cmd+=('--limit' '10')
cmd+=('release' 'list')
cmd+=('--repo' "opencord/$repo")
# gh release create [<tag>] [<files>...]
echo "** ${iam}: RUNNING " "${cmd[@]}"
"${cmd[@]}"
echo "** ${iam}: ENTER"
return
}
## -----------------------------------------------------------------------
## Intent:
## -----------------------------------------------------------------------
function github_release_pre()
{
local what="$1" ; shift
local user="$1" ; shift
local repo="$1" ; shift
local tag="$1" ; shift
local name="$1" ; shift
local descr="$1" ; shift
local iam="${FUNCNAME[0]}"
echo "** ${iam}: ENTER"
declare -p user
declare -p repo
declare -p tag
declare -p name
declare -p descr
case "$what" in
gh)
declare -a cmd=()
## [TODO] Refactor into a function accepting:
## --create
## --info
## --upload
cmd+=("$gh_cmd")
# cmd+=('--verbose')
cmd+=('release' 'create')
cmd+=("$tag") # no switch for tag, pass inline.
# cmd+=('--latest') # auto tag based on origin/master
# cmd+=('--target') # Use when a branch based release is needed.
cmd+=('--repo' "opencord/$repo")
cmd+=('--title' "$name")
# cmd+=('--descripton' "$descr") # not supported
cmd+=('--discussion-category' "Announcements")
# cmd+=('--verify-tag') # fatal
declare -p cmd
# gh release create [<tag>] [<files>...]
echo "** ${iam}: RUNNING " "${cmd[@]}"
"${cmd[@]}"
;;
*)
declare -a cmd=()
cmd+=('github-release')
# cmd+=('--verbose')
cmd+=('release')
cmd+=('--user' "$user")
cmd+=('--repo' "$repo")
cmd+=('--tag' "$tag")
cmd+=('--name' "$name")
cmd+=('--descripton' "$descr")
echo "** ${iam}: RUNNING " "${cmd[@]}"
"${cmd[@]}"
;;
esac
echo "** ${iam}: ENTER"
return
}
## -----------------------------------------------------------------------
## Intent:
## -----------------------------------------------------------------------
function install_gh_binary()
{
local iam="${FUNCNAME[0]}"
echo "** $iam: ENTER"
pushd "$scratch"
echo -e "\n** ${iam}: Retrieve latest gh download URLs"
local latest="https://github.com/cli/cli/releases/latest"
local tarball="gh.tar.tgz"
local VER
VER=$(curl --silent -qI "$latest" \
| awk -F '/' '/^location/ {print substr($NF, 1, length($NF)-1)}')
# echo "VER=[$VER]"
echo "** ${iam}: Download latest gh binary"
local url="https://github.com/cli/cli/releases/download/${VER}/gh_${VER#v}_linux_amd64.tar.gz"
wget --quiet --output-document="$tarball" "$url"
echo "** ${iam}: Unpack tarball"
tar zxf "$tarball"
gh_cmd="$(find "${scratch}" -name 'gh' -print)"
readonly gh_cmd
echo "** ${iam} Command: ${gh_cmd}"
echo "** ${iam} Version: $("$gh_cmd" --version)"
popd
echo "** $iam: LEAVE"
return
}
##----------------##
##---] MAIN [---##
##----------------##
iam="${0##*/}"
banner
init
install_gh_binary
# when not running under Jenkins, use current dir as workspace and a blank
# project name
WORKSPACE=${WORKSPACE:-.}
GERRIT_PROJECT=${GERRIT_PROJECT:-}
# Github organization (or user) this project is published on. Project name should
# be the same on both Gerrit and GitHub
GITHUB_ORGANIZATION=${GITHUB_ORGANIZATION:-}
# glob pattern relative to project dir matching release artifacts
# ARTIFACT_GLOB=${ARTIFACT_GLOB:-"release/*"} # stat -- release/* not found, literal string (?)
ARTIFACT_GLOB=${ARTIFACT_GLOB:-"release/."}
# Temporary staging directory to copy artifacts to
RELEASE_TEMP="$WORKSPACE/release"
mkdir -p "$RELEASE_TEMP"
# Use "release" as the default makefile target, can be a space separated list
RELEASE_TARGETS=${RELEASE_TARGETS:-release}
# check that we're on a semver released version, or exit
pushd "$GERRIT_PROJECT"
GIT_VERSION=$(git tag -l --points-at HEAD)
# match bare versions or v-prefixed golang style version
if [[ "$GIT_VERSION" =~ ^v?([0-9]+)\.([0-9]+)\.([0-9]+)$ ]]
then
echo "git has a SemVer released version tag: '$GIT_VERSION'"
echo "Building artifacts for GitHub release."
else
echo "No SemVer released version tag found, exiting..."
exit 0
fi
popd
# Set and handle GOPATH and PATH
export GOPATH=${GOPATH:-$WORKSPACE/go}
export PATH=$PATH:/usr/lib/go-1.12/bin:/usr/local/go/bin:$GOPATH/bin
# To support golang projects that require GOPATH to be set and code checked out there
# If $DEST_GOPATH is not an empty string:
# - create GOPATH within WORKSPACE, and destination directory within
# - set PATH to include $GOPATH/bin and the system go binaries
# - move project from $WORKSPACE/$GERRIT_PROJECT to new location in $GOPATH
# - start release process within that directory
DEST_GOPATH=${DEST_GOPATH:-}
if [ -n "$DEST_GOPATH" ]; then
mkdir -p "$GOPATH/src/$DEST_GOPATH"
release_path="$GOPATH/src/$DEST_GOPATH/$GERRIT_PROJECT"
mv "$WORKSPACE/$GERRIT_PROJECT" "$release_path"
else
release_path="$WORKSPACE/$GERRIT_PROJECT"
fi
if [ ! -f "$release_path/Makefile" ]; then
echo "Makefile not found at $release_path!"
exit 1
else
pushd "$release_path"
# Release description is sanitized version of the log message
RELEASE_DESCRIPTION="$(git log -1 --pretty=%B | tr -dc "[:alnum:]\n\r\.\[\]\:\-\\\/\`\' ")"
# build the release, can be multiple space separated targets
# shellcheck disable=SC2086
make "$RELEASE_TARGETS"
# doDebug # deterine why ARTIFACT_GLOB is empty
copyToRelease
cat <<EOM
** -----------------------------------------------------------------------
** Create the release:
** 1) Create initial github release with download area.
** 2) Generate checksum.SHA256 for all released files.
** 3) Upload files to complete the release.
** 4) Display released info from github.
** -----------------------------------------------------------------------
EOM
# git auth login
# git auth logout
gh release list [flags]
echo "** ${iam} List releases"
github_release_list \
"$GITHUB_ORGANIZATION"\
"$GERRIT_PROJECT"
# Usage: github-release [global options] <verb> [verb options]
# create release
echo "** ${iam} Creating Release: $GERRIT_PROJECT - $GIT_VERSION"
github_release_pre 'gh'\
"$GITHUB_ORGANIZATION"\
"$GERRIT_PROJECT"\
"$GIT_VERSION"\
"$GERRIT_PROJECT - $GIT_VERSION"\
"$RELEASE_DESCRIPTION"
echo "** ${iam} Packaging release files"
pushd "$RELEASE_TEMP"
echo "** ${iam}: Files to release:"
readarray -t to_release < <(find . -mindepth 1 -maxdepth 1 -type f -print)
declare -p to_release
# Generate and check checksums
sha256sum -- * > checksum.SHA256
sha256sum -c < checksum.SHA256
echo
echo "** ${iam} Checksums(checksum.SHA256):"
cat checksum.SHA256
echo
echo "** ${iam} Upload files being released"
# shellcheck disable=SC2194
case 'gh' in
gh)
declare -a cmd=()
cmd+=("$gh_cmd")
cmd+=('release' 'upload')
cmd+=("$GIT_VERSION")
cmd+=('--repo' "opencord/${GERRIT_PROJECT}")
cmd+=("${to_release[@]}")
declare -p cmd
# gh release upload <tag> <files>... [flags]
"${cmd[@]}"
;;
*)
# upload all files to the release
for rel_file in *
do
echo "** ${iam} Uploading file: $rel_file"
github-release \
upload \
--user "$GITHUB_ORGANIZATION" \
--repo "$GERRIT_PROJECT" \
--tag "$GIT_VERSION" \
--name "$rel_file" \
--file "$rel_file"
done
;;
esac
popd
popd
fi
# [SEE ALSO]
# -----------------------------------------------------------------------
# https://www.shellcheck.net/wiki/SC2236
# https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#create-a-release
# -----------------------------------------------------------------------
# https://cli.github.com/manual/gh_help_reference
# https://cli.github.com/manual/gh_release
# -----------------------------------------------------------------------
# [EOF]