blob: 48a127cf8f4d38cd3099dc49201603a24a3e478b [file] [log] [blame]
Zack Williams27cd3e52018-09-18 16:44:50 -07001#!/usr/bin/env bash
Joey Armstrong28eddda2023-01-10 03:09:34 -05002# -----------------------------------------------------------------------
3# Copyright 2018-2023 Open Networking Foundation (ONF) and the ONF Contributors
Zack Williams27cd3e52018-09-18 16:44:50 -07004#
5# Licensed under the Apache License, Version 2.0 (the "License");
6# you may not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9# http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
Joey Armstrong28eddda2023-01-10 03:09:34 -050016#
Zack Williams27cd3e52018-09-18 16:44:50 -070017# github-release.sh
18# builds (with make) and uploads release artifacts (binaries, etc.) to github
19# given a tag also create checksums files and release notes from the commit
20# message
Joey Armstrong28eddda2023-01-10 03:09:34 -050021# -----------------------------------------------------------------------
Zack Williams27cd3e52018-09-18 16:44:50 -070022
Joey Armstrong2097d3e2023-03-26 10:32:03 -040023set -euo pipefail
24
25##-------------------##
26##---] GLOBALS [---##
27##-------------------##
28declare -g WORKSPACE
29declare -g GERRIT_PROJECT
Joey Armstrong78cecc52023-04-03 11:39:11 -040030declare -g __githost=github.com
Joey Armstrong43c48422023-04-03 10:17:32 -040031# export DEBUG=1
Joey Armstrong2097d3e2023-03-26 10:32:03 -040032
33## -----------------------------------------------------------------------
34## Uncomment to activate
35## -----------------------------------------------------------------------
Joey Armstronge8560da2023-04-26 15:44:45 -040036# Debug arguments
37# declare -i -g argv_gen_version=1
38# declare -i -g draft_release=1
Joey Armstrong41923cc2023-01-30 14:38:16 -050039
Joey Armstrong2097d3e2023-03-26 10:32:03 -040040declare -a -g ARGV=() # Capture args to minimize globals and arg passing
41[[ $# -gt 0 ]] && ARGV=("$@")
Joey Armstrongd99e3d22023-01-29 12:35:43 -050042
43declare -g scratch # temp workspace for downloads
Joey Armstrongd99e3d22023-01-29 12:35:43 -050044
Joey Armstronge8560da2023-04-26 15:44:45 -040045declare -g SCRIPT_VERSION='1.4' # git changeset needed
Joey Armstrong26707f02023-01-26 12:41:12 -050046
Joey Armstrong7f382ef2023-01-25 12:00:08 -050047##--------------------##
48##---] INCLUDES [---##
Joey Armstrong1962bcf2023-01-27 13:53:18 -050049##--------------------#
Joey Armstrong2097d3e2023-03-26 10:32:03 -040050
51## -----------------------------------------------------------------------
52## Intent: Register an interrupt handler to display a stack trace on error
53## -----------------------------------------------------------------------
54function errexit()
55{
56 local err=$?
57 set +o xtrace
58 local code="${1:-1}"
59
60 local prefix="${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
61 echo -e "\nOFFENDER: ${prefix}"
62 if [ $# -gt 0 ] && [ "$1" == '--stacktrace-quiet' ]; then
63 code=1
64 else
65 echo "ERROR: '${BASH_COMMAND}' exited with status $err"
66 fi
67
68 # Print out the stack trace described by $function_stack
69 if [ ${#FUNCNAME[@]} -gt 2 ]
70 then
Joey Armstrong43c48422023-04-03 10:17:32 -040071 echo "Call tree:"
72 for ((i=1;i<${#FUNCNAME[@]}-1;i++))
73 do
74 echo " $i: ${BASH_SOURCE[$i+1]}:${BASH_LINENO[$i]} ${FUNCNAME[$i]}(...)"
75 done
Joey Armstrong2097d3e2023-03-26 10:32:03 -040076 fi
77
78 echo "Exiting with status ${code}"
79 echo
80 exit "${code}"
81 # return
82}
83
84# trap ERR to provide an error handler whenever a command exits nonzero
85# this is a more verbose version of set -o errexit
86trap errexit ERR
87
88# setting errtrace allows our ERR trap handler to be propagated to functions,
89# expansions and subshells
90set -o errtrace
Joey Armstrong7f382ef2023-01-25 12:00:08 -050091
92## -----------------------------------------------------------------------
Joey Armstrongd99e3d22023-01-29 12:35:43 -050093## Intent: Cleanup scratch area on exit
94## -----------------------------------------------------------------------
95function sigtrap()
96{
97 ## Prevent mishaps
98 local is_read_only
99 is_read_only="$(declare -p scratch)"
100 if [[ $is_read_only != *"declare -r scratch="* ]]; then
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400101 echo "ERROR: variable scratch is not read-only, cleanup skipped"
102 exit 1
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500103 fi
104
105 if [ -d "$scratch" ]; then
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400106 /bin/rm -fr "$scratch"
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500107 fi
108
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400109 do_logout 'shellcheck-SC2119'
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500110 return
111}
112trap sigtrap EXIT
113
114## -----------------------------------------------------------------------
Joey Armstronge8560da2023-04-26 15:44:45 -0400115## Intent: Return a random release version string.
116## -----------------------------------------------------------------------
117## Note: Do not use this function in production. get_version() is
118## intended for local use or debugging $0 from within a jenkins
119## job.
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400120## -----------------------------------------------------------------------
121function get_version()
122{
123 declare -n ref="$1"
124
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400125 declare -a rev=()
126 rev+=("$(( RANDOM % 10 + 1 ))")
127 rev+=("$(( RANDOM % 256 + 1 ))")
Joey Armstrongeef8c2c2023-03-27 17:27:43 -0400128 rev+=("$(( RANDOM % 10000 + 1 ))")
Joey Armstrongfc20ed52023-04-03 19:37:58 -0400129 local ver="v${rev[0]}.${rev[1]}.${rev[2]}"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400130
Joey Armstrong43c48422023-04-03 10:17:32 -0400131 func_echo "VERSION: $ver"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400132 ref="$ver"
133 return
134}
135
136## -----------------------------------------------------------------------
137## Intent: Provide defaults for environment variables
138## -----------------------------------------------------------------------
139function initEnvVars()
140{
141 # when not running under Jenkins, use current dir as workspace and a blank
142 # project name
143 declare -g WORKSPACE=${WORKSPACE:-.}
144 declare -g GERRIT_PROJECT=${GERRIT_PROJECT:-}
Joey Armstrong76026b72023-03-29 12:19:17 -0400145
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400146 # Github organization (or user) this project is published on. Project name should
147 # be the same on both Gerrit and GitHub
Joey Armstrong76026b72023-03-29 12:19:17 -0400148 declare -g GITHUB_ORGANIZATION=${GITHUB_ORGANIZATION:-}
149
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400150 # glob pattern relative to project dir matching release artifacts
151 # ARTIFACT_GLOB=${ARTIFACT_GLOB:-"release/*"} # stat -- release/* not found, literal string (?)
152 declare -g ARTIFACT_GLOB=${ARTIFACT_GLOB:-"release/."}
Joey Armstrong76026b72023-03-29 12:19:17 -0400153
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400154 # Use "release" as the default makefile target, can be a space separated list
155 declare -g RELEASE_TARGETS=${RELEASE_TARGETS:-release}
Joey Armstrong76026b72023-03-29 12:19:17 -0400156
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400157 # Set and handle GOPATH and PATH
158 export GOPATH=${GOPATH:-$WORKSPACE/go}
159 export PATH=$PATH:/usr/lib/go-1.12/bin:/usr/local/go/bin:$GOPATH/bin
160 return
161}
162
163## -----------------------------------------------------------------------
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500164## Intent: Create a scratch area for downloads and transient tools
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400165## temp directory will be automatically removed upon exit.
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500166## -----------------------------------------------------------------------
167function init()
168{
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500169 local pkgbase="${0##*/}" # basename
170 local pkgname="${pkgbase%.*}"
171
Joey Armstrongad7b1e02023-03-27 11:55:48 -0400172 # initEnvVars # moved to full_banner()
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400173
174 ## Create a temp directory for auto-cleanup
175 declare -g scratch
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500176 scratch="$(mktemp -d -t "${pkgname}.XXXXXXXXXX")"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400177 readonly scratch
178 declare -p scratch
179
Joey Armstrong43c48422023-04-03 10:17:32 -0400180 ## prime the stream: cache answers
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400181 local work
182 get_release_dir work
183 declare -p work
Joey Armstrong43c48422023-04-03 10:17:32 -0400184
Joey Armstronge8560da2023-04-26 15:44:45 -0400185 local git_version
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400186 getGitVersion git_version
187 func_echo "$(declare -p git_version)"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400188 return
189}
190
191## -----------------------------------------------------------------------
192## Intent: Verbose output for logging
193## -----------------------------------------------------------------------
194function banner()
195{
196 local iam="${0##*/}"
197 cat <<EOB
198
199** -----------------------------------------------------------------------
200** ${iam}::${FUNCNAME[1]}: $*
201** -----------------------------------------------------------------------
202EOB
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500203}
204
205## -----------------------------------------------------------------------
Joey Armstrong7f382ef2023-01-25 12:00:08 -0500206## Intent: Output a log banner to identify the running script/version.
207## -----------------------------------------------------------------------
208## TODO:
209## o SCRIPT_VERSION => git changeset for repo:ci-managment
210## o echo "library version: ${env."library.libName.version"}"
211# -----------------------------------------------------------------------
212# 14:18:38 > git fetch --no-tags --progress -- https://gerrit.opencord.org/ci-management.git +refs/heads/*:refs/remotes/origin/* # timeout=10
213# 14:18:39 Checking out Revision 50f6e0b97f449b32d32ec0e02d59642000351847 (master)
214# -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400215function full_banner()
Joey Armstrong7f382ef2023-01-25 12:00:08 -0500216{
Joey Armstrongad7b1e02023-03-27 11:55:48 -0400217 local iam="${0##*/}"
218
219 initEnvVars # set defaults
Joey Armstrong7f382ef2023-01-25 12:00:08 -0500220
221cat <<EOH
222
223** -----------------------------------------------------------------------
224** IAM: ${iam} :: ${FUNCNAME[0]}
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400225** ARGV: ${ARGV[@]}
Joey Armstrong7f382ef2023-01-25 12:00:08 -0500226** PWD: $(/bin/pwd)
227** NOW: $(date '+%Y/%m/%d %H:%M:%S')
228** VER: ${SCRIPT_VERSION:-'unknown'}
229** -----------------------------------------------------------------------
Joey Armstrongad7b1e02023-03-27 11:55:48 -0400230** GERRIT_PROJECT: $(declare -p GERRIT_PROJECT)
231** GITHUB_ORGANIZATION: $(declare -p GITHUB_ORGANIZATION)
232** RELEASE_TARGETS: $(declare -p RELEASE_TARGETS)
233** GOPATH: $(declare -p GOPATH)
234** -----------------------------------------------------------------------
235** PATH += /usr/lib/go-1.12/bin:/usr/local/go/bin:GOPATH/bin
236** -----------------------------------------------------------------------
Joey Armstrong7f382ef2023-01-25 12:00:08 -0500237EOH
238
239 return
240}
241
Joey Armstrongaf577ab2022-12-15 14:43:33 -0500242## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400243## Intent: Display a message with 'iam' identifier for logging
Joey Armstrong50f6e0b2023-01-24 14:14:08 -0500244## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400245function func_echo()
Joey Armstrong1962bcf2023-01-27 13:53:18 -0500246{
247 local iam="${0##*/}"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400248 echo "** ${iam} :: ${FUNCNAME[1]}: $*"
Joey Armstrong1962bcf2023-01-27 13:53:18 -0500249 return
250}
251
252## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400253## Intent: Display an error message then exit with status.
254## -----------------------------------------------------------------------
255function error()
256{
257 local iam="${0##*/}"
258 echo "ERROR ${iam} :: ${FUNCNAME[1]}: $*"
259 exit 1
260}
261
262## -----------------------------------------------------------------------
263## Intent: Verify sandbox/build is versioned for release.
264## -----------------------------------------------------------------------
265function getGitVersion()
266{
267 declare -n varname="$1"; shift
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400268
Joey Armstrong43c48422023-04-03 10:17:32 -0400269 local __ver # use prefix('__') to protect callers variable name
270 if [[ -v cached_getGitVersion ]]; then
271 __ver="$cached_getGitVersion"
272 varname="$__ver"
273 return
Joey Armstrong39fac652023-03-27 18:50:43 -0400274
Joey Armstrong43c48422023-04-03 10:17:32 -0400275 elif [[ -v argv_gen_version ]]; then
276 get_version __ver
277
278 elif [[ -v WORKSPACE ]] && [[ -v GITHUB_TOKEN ]]; then # i_am_jenkins
Joey Armstrongf9a0a882023-04-17 11:53:57 -0400279 local path="$GERRIT_PROJECT"
280 pushd "$path" || error "pushd GERRIT_PROJECT= failed $(declare -p path)"
Joey Armstrong43c48422023-04-03 10:17:32 -0400281 __ver="$(git tag -l --points-at HEAD)"
Joey Armstrongf9a0a882023-04-17 11:53:57 -0400282 popd || error "popd GERRIT_PROJECT= failed"
Joey Armstrong43c48422023-04-03 10:17:32 -0400283
284 elif [[ -v argv_version_file ]]; then # local debug
285 [[ ! -f VERSION ]] && error "./VERSION file not found"
286 readarray -t tmp < <(sed -e 's/[[:blank:]]//g' 'VERSION')
287 __ver="v${tmp[0]}"
288
289 else
Joey Armstrongf9a0a882023-04-17 11:53:57 -0400290 cd ..
291 local path="$GERRIT_PROJECT"
292 pushd "$path" || error "pushd GERRIT_PROJECT= failed $(declare -p path)"
Joey Armstrong43c48422023-04-03 10:17:32 -0400293 __ver="$(git tag -l --points-at HEAD)"
Joey Armstrongf9a0a882023-04-17 11:53:57 -0400294 popd || error "popd GERRIT_PROJECT= failed"
Joey Armstrong43c48422023-04-03 10:17:32 -0400295 fi
Joey Armstrong76026b72023-03-29 12:19:17 -0400296
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400297 # ------------------------------------------------------
298 # match bare versions or v-prefixed golang style version
299 # Critical failure for new/yet-to-be-released repo ?
300 # ------------------------------------------------------
Joey Armstrong43c48422023-04-03 10:17:32 -0400301 if [[ "$__ver" =~ ^v?([0-9]+)\.([0-9]+)\.([0-9]+)$ ]]; then
Joey Armstrongfc20ed52023-04-03 19:37:58 -0400302 echo "git has a SemVer released version tag: '$__ver'"
Joey Armstrong43c48422023-04-03 10:17:32 -0400303 echo "Building artifacts for GitHub release."
304
305 elif [[ "$__ver" =~ ^v?([0-9]+)\.([0-9]+)\.([0-9]+)-dev([0-9]+)$ ]]; then
Joey Armstronge8560da2023-04-26 15:44:45 -0400306 # v1.2.3-dev (*-dev*) is an implicit draft release.
Joey Armstrong43c48422023-04-03 10:17:32 -0400307 declare -i -g draft_release=1
308 echo "Detected --draft SemVer release version tag [$__ver]"
309 echo "Building artifacts for GitHub release."
310
Joey Armstrong4f87de82023-08-25 12:42:39 -0400311 # Should also accept: X.Y.Z-{alpha,beta,...}
312
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400313 else
Joey Armstrong4f87de82023-08-25 12:42:39 -0400314 echo "Version string contains: [${__ver}]"
Joey Armstrong43c48422023-04-03 10:17:32 -0400315 error "No SemVer released version tag found, exiting..."
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400316 fi
317
Joey Armstrong43c48422023-04-03 10:17:32 -0400318 ## Cache value for subsequent calls.
319 ## readonly is a guarantee assignment happens once.
320 declare -g cached_getGitVersion="$__ver"
321 readonly cached_getGitVersion;
322
323 varname="$__ver"
324 func_echo "Version is [$__ver] from $(/bin/pwd)"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400325 return
326}
327
328## -----------------------------------------------------------------------
329## Intent:
330## Note: Release description is sanitized version of the log message
331## -----------------------------------------------------------------------
332function getReleaseDescription()
333{
334 declare -n varname="$1"; shift
335
336 local msg
337 msg="$(git log -1 --pretty=%B)"
338
339 local val
340 val="$(tr -dc "[:alnum:]\n\r\.\[\]\:\-\\\/\`\' " <<< "$msg")"
341
342 [[ ${#val} -eq 0 ]] && error "Release Description is empty ($msg)"
343 varname="$val"
344 return
345}
346
347## -----------------------------------------------------------------------
348## Intent: Retrieve value of the release temp directory.
349## -----------------------------------------------------------------------
350## Note: Limit use of globals so logic can be isolated in function calls.
351## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400352function get_release_dir()
353{
354 declare -n varname=$1; shift
355
356 # Temporary staging directory to copy artifacts to
357 varname="$scratch/release"
358 mkdir -p "$varname"
359 return
360}
361
362## -----------------------------------------------------------------------
363## Intent: Retrieve github server hostname
364## -----------------------------------------------------------------------
365function get_gh_hostname()
366{
367 declare -n varname=$1; shift
368 varname+=('--hostname' "${__githost}")
369 return
370}
371
372## -----------------------------------------------------------------------
373## Intent: Retrieve repository organizaiton name
374## -----------------------------------------------------------------------
375function get_gh_repo_org()
376{
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400377 declare -n ref=$1; shift
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400378 declare -g __repo_org
Joey Armstrong76026b72023-03-29 12:19:17 -0400379
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400380 local org
381 if [[ -v __repo_org ]]; then
Joey Armstrong43c48422023-04-03 10:17:32 -0400382 org="$__repo_org"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400383 elif [[ ! -v GITHUB_ORGANIZATION ]]; then
Joey Armstrong43c48422023-04-03 10:17:32 -0400384 error "--repo-org or GITHUB_ORGANIZATION= are required"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400385 else
Joey Armstrong43c48422023-04-03 10:17:32 -0400386 org="${GITHUB_ORGANIZATION}"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400387 fi
388
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400389 ref="$org"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400390 return
391}
392
393## -----------------------------------------------------------------------
394## Intent: Retrieve repository organizaiton name
395## -----------------------------------------------------------------------
396function get_gh_repo_name()
397{
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400398 declare -n ref=$1; shift
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400399 declare -g __repo_name
Joey Armstrong76026b72023-03-29 12:19:17 -0400400
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400401 local name
402 if [[ -v __repo_name ]]; then
Joey Armstrong43c48422023-04-03 10:17:32 -0400403 name="$__repo_name"
Joey Armstrong39fac652023-03-27 18:50:43 -0400404 elif [[ ! -v GERRIT_PROJECT ]]; then
Joey Armstrong43c48422023-04-03 10:17:32 -0400405 error "--repo-name or GERRIT_PROJECT= are required"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400406 else
Joey Armstrong43c48422023-04-03 10:17:32 -0400407 name="${GERRIT_PROJECT}"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400408 fi
409
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400410 ref="$name"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400411 return
412}
413
414## -----------------------------------------------------------------------
415## Intent: Return path for the gh release query
416## -----------------------------------------------------------------------
417function get_gh_releases()
418{
419 declare -n ref="$1"
420
421 local repo_org
422 get_gh_repo_org repo_org
423
424 local repo_name
425 get_gh_repo_name repo_name
426
427 ref="repos/${repo_org}/${repo_name}/releases"
428 func_echo "ref=$ref"
429 return
430}
431
432## -----------------------------------------------------------------------
433## Intent: Retrieve repository path argument
434## -----------------------------------------------------------------------
435function get_argv_repo()
436{
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400437 declare -n ref=$1; shift
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400438
439 local repo_org
440 get_gh_repo_org repo_org
Joey Armstrong76026b72023-03-29 12:19:17 -0400441
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400442 local repo_name
Joey Armstrong76026b72023-03-29 12:19:17 -0400443 get_gh_repo_name repo_name
444
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400445 ref="${repo_org}/${repo_name}"
446 # func_echo "ref=$(declare -p ref)"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400447 return
448}
449
450## -----------------------------------------------------------------------
451## Intent: Retrieve release name string "project - version"
452## -----------------------------------------------------------------------
453function get_argv_name()
454{
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400455 declare -n ref=$1; shift
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400456
457 local repo_name
458 get_gh_repo_name repo_name
Joey Armstrong43c48422023-04-03 10:17:32 -0400459
460 local repo_ver
461 getGitVersion repo_ver
462
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400463 # ref="${repo_name} - $GIT_VERSION"
464 ref="${repo_name} - ${repo_ver}"
465 func_echo "ref=$(declare -p ref)"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400466 return
467}
468
469## -----------------------------------------------------------------------
470## Intent: Retrieve tag version
471## -----------------------------------------------------------------------
472function get_argv_tag()
473{
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400474 declare -n ref=$1; shift
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400475
476 # cached_argv_tag='v3.41.3204'
477 if [[ ! -v cached_argv_tag ]]; then
Joey Armstrong43c48422023-04-03 10:17:32 -0400478 declare -g cached_argv_tag
479 if [[ -v GIT_VERSION ]]; then # hello jenkins
480 cached_argv_tag="$GIT_VERSION"
481 fi
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400482 fi
483
484 [[ ${#cached_argv_tag} -eq 0 ]] && error "Unable to determine GIT_VERSION="
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400485 ref="$cached_argv_tag"
486 func_echo "ref=$(declare -p ref)"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400487 return
488}
489
490## -----------------------------------------------------------------------
491## Intent:
492## -----------------------------------------------------------------------
493# To support golang projects that require GOPATH to be set and code checked out there
494# If $DEST_GOPATH is not an empty string:
495# - create GOPATH within WORKSPACE, and destination directory within
496# - set PATH to include $GOPATH/bin and the system go binaries
497# - move project from $WORKSPACE/$GERRIT_PROJECT to new location in $GOPATH
498# - start release process within that directory
499## -----------------------------------------------------------------------
500function get_release_path()
501{
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400502 declare -n ref=$1; shift
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400503
Joey Armstronge8560da2023-04-26 15:44:45 -0400504 # shellcheck disable=SC2128
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400505 local varpath="$ref"
Joey Armstronge8560da2023-04-26 15:44:45 -0400506
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400507 DEST_GOPATH=${DEST_GOPATH:-}
508 if [ -n "$DEST_GOPATH" ]; then
Joey Armstrong43c48422023-04-03 10:17:32 -0400509 mkdir -p "$GOPATH/src/$DEST_GOPATH"
Joey Armstronge8560da2023-04-26 15:44:45 -0400510 varpath="$GOPATH/src/$DEST_GOPATH/$GERRIT_PROJECT"
511 mv "$WORKSPACE/$GERRIT_PROJECT" "$varpath"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400512 else
Joey Armstronge8560da2023-04-26 15:44:45 -0400513 varpath="$WORKSPACE/$GERRIT_PROJECT"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400514 fi
515
Joey Armstrong43c48422023-04-03 10:17:32 -0400516 ## Verify pwd is OK
517 for path in \
Joey Armstronge8560da2023-04-26 15:44:45 -0400518 "${varpath}/Makefile"\
519 "${varpath}/makefile"\
Joey Armstrong43c48422023-04-03 10:17:32 -0400520 "__ERROR__"\
521 ; do
522 case "$path" in
Joey Armstronge8560da2023-04-26 15:44:45 -0400523 __ERROR__) error "Makefile not found at ${varpath} !" ;;
Joey Armstrong43c48422023-04-03 10:17:32 -0400524 *) [[ -f "$path" ]] && break ;;
525 esac
526 done
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400527
528 return
529}
530
531## -----------------------------------------------------------------------
532## Intent: Display future enhancements
533## -----------------------------------------------------------------------
534function todo()
535{
536 local iam="${0##*/}"
537
538cat <<EOT
539
540** -----------------------------------------------------------------------
541** IAM: ${iam} :: ${FUNCNAME[0]}
542** -----------------------------------------------------------------------
543 o get_release_path()
544 - refactor redundant paths into local vars.
545 - see comments, do we have a one-off failure condition ?
Joey Armstrongad7b1e02023-03-27 11:55:48 -0400546 o PATH += golang appended 3 times, release needs a single, reliable answer.
547 o do_login, do_logout and api calls do not use the my_gh wrapper:
548 - Add a lookup function to cache and retrieve path to downloaded gh command.
Joey Armstrong76026b72023-03-29 12:19:17 -0400549
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400550EOT
551
552 return
553}
554
555## -----------------------------------------------------------------------
Joey Armstrong76026b72023-03-29 12:19:17 -0400556## Intent: Verify a directory contains content for release.
557## -----------------------------------------------------------------------
558## Given:
559## scalar Path to release/ directory
560## ref Results returned through this indirect var.
561## -----------------------------------------------------------------------
562## Usage:
563## declare -a artifacts=()
564## get_artifacts '/foo/bar/tans' artifacts
565## declare -p artifacts
566## -----------------------------------------------------------------------
567function get_artifacts()
568{
569 local dir="$1" ; shift
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400570 declare -n refA=$1 ; shift
Joey Armstrong76026b72023-03-29 12:19:17 -0400571
Joey Armstrong55fe80e2023-04-05 18:32:14 -0400572 # Glob available files, exclude checksums
573 readarray -t __artifacts < <(find "$dir" -mindepth 1 ! -type d \
Joey Armstrongf9a0a882023-04-17 11:53:57 -0400574 | grep -iv -e 'sum256' -e 'checksum')
575 # func_echo "$(declare -p __artifacts)"
Joey Armstrong76026b72023-03-29 12:19:17 -0400576
577 # -----------------------------------------------------------------------
578 # Verify count>0 to inhibit source-only release
579 # Problem children:
580 # o build or make release failures.
581 # o docker container filesystem mount problem (~volume)
582 # -----------------------------------------------------------------------
583 [[ ${#__artifacts[@]} -eq 0 ]] \
Joey Armstrong43c48422023-04-03 10:17:32 -0400584 && error "Artifact dir is empty: $(declare -p dir)"
Joey Armstrong76026b72023-03-29 12:19:17 -0400585
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400586 # shellcheck disable=SC2034
587 refA=("${__artifacts[@]}")
Joey Armstrong76026b72023-03-29 12:19:17 -0400588 return
589}
590
591## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400592## Intent: Copy files from the build directory into the release staging
593## directory for publishing to github releases/ endpoint.
Joey Armstrong26707f02023-01-26 12:41:12 -0500594## -----------------------------------------------------------------------
595function copyToRelease()
596{
Joey Armstrong76026b72023-03-29 12:19:17 -0400597 banner ''
Joey Armstrong26707f02023-01-26 12:41:12 -0500598
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400599 local artifact_glob="${ARTIFACT_GLOB%/*}"
600 func_echo "$(declare -p artifact_glob)"
601
602 local work
603 get_release_dir work
Joey Armstrong76026b72023-03-29 12:19:17 -0400604 func_echo "Artifact dir: $(declare -p work)"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400605
Joey Armstrong76026b72023-03-29 12:19:17 -0400606 ## Verify release content is available
607 declare -a artifacts=()
Joey Armstrong43c48422023-04-03 10:17:32 -0400608 # get_artifacts "$work" artifacts
609 get_artifacts "$artifact_glob" artifacts
610 func_echo "Artifacts in copy_from: $(declare -p artifacts)"
Joey Armstrong472bfba2023-03-27 18:12:28 -0400611
Joey Armstrong26707f02023-01-26 12:41:12 -0500612 # Copy artifacts into the release temp dir
613 # shellcheck disable=SC2086
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400614 echo "rsync -rv --checksum \"$artifact_glob/.\" \"$work/.\""
615 rsync -rv --checksum "$artifact_glob/." "$work/."
Joey Armstrong1962bcf2023-01-27 13:53:18 -0500616
Joey Armstrong43c48422023-04-03 10:17:32 -0400617 get_artifacts "$work" artifacts
618 func_echo "Artifacts in copy_to: $(declare -p artifacts)"
619
Joey Armstrong26707f02023-01-26 12:41:12 -0500620 return
621}
622
623## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400624## https://docs.github.com/en/rest/releases?apiVersion=2022-11-28
625 # https://cli.github.com/manual/gh_release_create
626 # --target <branch> or commit SHA
627 # --title
628 # --generate-notes
629 # --release-notes (notes file)
630 # --release
631 # release create dist/*.tgz
632 # --discussion-category "General"
Joey Armstrongf085d872023-01-28 17:52:29 -0500633## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400634# https://cli.github.com/manual/gh_release_create
635## -----------------------------------------------------------------------
636function gh_release_create()
Joey Armstrong38bfeea2023-02-06 18:01:29 -0500637{
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400638 banner ''
Joey Armstrong38bfeea2023-02-06 18:01:29 -0500639
Joey Armstrong43c48422023-04-03 10:17:32 -0400640 local version
641 getGitVersion version
Joey Armstrong38bfeea2023-02-06 18:01:29 -0500642
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400643 local work
644 get_release_dir work
645
Joey Armstrong43c48422023-04-03 10:17:32 -0400646 declare -a args=()
647 args+=('--host-repo')
648 args+=('--title')
649 if [[ -v draft_release ]]; then
650 args+=('--draft')
651 else
652 args+=('--discussion-category' 'Announcements')
653 fi
654
Joey Armstrong55fe80e2023-04-05 18:32:14 -0400655 if [[ -v release_notes ]]; then
Joey Armstrongf9a0a882023-04-17 11:53:57 -0400656 args+=('--notes-file' "$release_notes")
Joey Armstrong55fe80e2023-04-05 18:32:14 -0400657 fi
Joey Armstrong43c48422023-04-03 10:17:32 -0400658
Joey Armstrong78cecc52023-04-03 11:39:11 -0400659 pushd "$work/.." >/dev/null
Joey Armstrongf9a0a882023-04-17 11:53:57 -0400660 # func_echo "WORK=$work"
Joey Armstrong78cecc52023-04-03 11:39:11 -0400661 readarray -t payload < <(find 'release' -maxdepth 4 ! -type d -print)
Joey Armstrong76026b72023-03-29 12:19:17 -0400662
Joey Armstronge8560da2023-04-26 15:44:45 -0400663 func_echo "$gh_cmd release create ${version} ${args[*]} ${payload[*]}"
Joey Armstrong43c48422023-04-03 10:17:32 -0400664
665 if [[ -v dry_run ]]; then
666 echo "[SKIP] dry run"
667 else
Joey Armstronge8560da2023-04-26 15:44:45 -0400668 func_echo "my_gh release create '$version' ${args[*]} ${payload[*]}"
Joey Armstrong4dbe7002023-04-04 12:47:38 -0400669 my_gh 'release' 'create' "$version" "${args[@]}" "${payload[@]}"
Joey Armstrong43c48422023-04-03 10:17:32 -0400670 fi
Joey Armstrong76026b72023-03-29 12:19:17 -0400671 popd >/dev/null
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400672
Joey Armstrong38bfeea2023-02-06 18:01:29 -0500673 return
674}
675
676## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400677## Intent: Authenticate credentials for a github gh session
Joey Armstrong38bfeea2023-02-06 18:01:29 -0500678## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400679## NOTE: my_gh currently unused due to --with-token < "$pac"
680## -----------------------------------------------------------------------
681function do_login()
Joey Armstrongf085d872023-01-28 17:52:29 -0500682{
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400683 # shellcheck disable=SC2120
684 # shellcheck disable=SC2034
685 local unused="$1"; shift
686
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400687 declare -g pac
Joey Armstrong485081f2023-03-27 13:34:08 -0400688 declare -a login_args=()
689 [[ $# -gt 0 ]] && login_args+=("$@")
Joey Armstrongf085d872023-01-28 17:52:29 -0500690
Joey Armstrong485081f2023-03-27 13:34:08 -0400691 # https://github.com/cli/cli/issues/2922#issuecomment-775027762
Joey Armstrong75a0d932023-03-28 08:59:54 -0400692 # (sigh) why not quietly return VS forcing a special logic path
Joey Armstronge6e18eb2023-03-27 14:19:21 -0400693 # [[ -v WORKSPACE ]] && [[ -v GITHUB_TOKEN ]] && return
694
695# 12:58:36 ** -----------------------------------------------------------------------
696# 12:58:36 ** jenkins582353203049151829.sh::do_login: --hostname github.com
697# 12:58:36 ** --------------------------------------------------------------------# ---
698# 12:58:36 ** jenkins582353203049151829.sh :: do_login: Detected ENV{GITHUB_TOKEN}=
699# 12:58:36 The value of the GITHUB_TOKEN environment variable is being used for authentication.
700# 12:58:36 To have GitHub CLI store credentials instead, first clear the value from the environment.
Joey Armstrong43c48422023-04-03 10:17:32 -0400701# -----------------------------------------------------------------------
Joey Armstrong76026b72023-03-29 12:19:17 -0400702
Joey Armstrong485081f2023-03-27 13:34:08 -0400703 get_gh_hostname login_args
Joey Armstrongf085d872023-01-28 17:52:29 -0500704
Joey Armstrong485081f2023-03-27 13:34:08 -0400705 banner "${login_args[@]}"
Joey Armstrong78cecc52023-04-03 11:39:11 -0400706 func_echo "$(declare -p WORKSPACE)"
Joey Armstrongf085d872023-01-28 17:52:29 -0500707
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400708 ## Read from disk is safer than export GITHUB_TOKEN=
709 if [[ -v pac ]] && [[ ${#pac} -gt 0 ]]; then # interactive/debugging
Joey Armstrong43c48422023-04-03 10:17:32 -0400710 [ ! -f "$pac" ] && error "PAC token file $pac does not exist"
Joey Armstronge8560da2023-04-26 15:44:45 -0400711 func_echo "$gh_cmd auth login ${login_args[*]} --with-token < $pac"
Joey Armstrong485081f2023-03-27 13:34:08 -0400712 "$gh_cmd" auth login "${login_args[@]}" --with-token < "$pac"
Joey Armstrongf085d872023-01-28 17:52:29 -0500713
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400714 elif [[ ! -v GITHUB_TOKEN ]]; then
715 error "--token [t] or GITHUB_TOKEN= are required"
Joey Armstrong41923cc2023-01-30 14:38:16 -0500716
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400717 else # jenkins
Joey Armstronge8560da2023-04-26 15:44:45 -0400718 func_echo "$gh_cmd auth login ${login_args[*]} (ie: jenkins)"
Joey Armstrong733ea9f2023-04-03 21:19:46 -0400719
Joey Armstrongf9a0a882023-04-17 11:53:57 -0400720 # https://github.com/cli/cli/issues/2922#issuecomment-775027762
721 # When using GITHUB_TOKEN, there is no need to even run gh auth login
Joey Armstrong733ea9f2023-04-03 21:19:46 -0400722 # "$gh_cmd" auth login "${login_args[@]}"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400723 fi
Joey Armstrongf085d872023-01-28 17:52:29 -0500724
Joey Armstrong43c48422023-04-03 10:17:32 -0400725 declare -i -g active_login=1 # signal logout needed
Joey Armstrongf085d872023-01-28 17:52:29 -0500726
Joey Armstrongf085d872023-01-28 17:52:29 -0500727 return
728}
729
730## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400731## Intent: Destroy credentials/gh session authenticated by do_login
732## -----------------------------------------------------------------------
733## NOTE: my_gh currently unused due to "<<< 'y'"
734## -----------------------------------------------------------------------
735function do_logout()
736{
737 declare -i -g active_login
738 [[ ! -v active_login ]] && return
739
Joey Armstrong78cecc52023-04-03 11:39:11 -0400740 declare -a logout_args=()
741 [[ $# -gt 0 ]] && logout_args+=("$@")
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400742
Joey Armstrong78cecc52023-04-03 11:39:11 -0400743 get_gh_hostname logout_args
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400744
Joey Armstrong78cecc52023-04-03 11:39:11 -0400745 banner "${logout_args[@]}"
Joey Armstronge8560da2023-04-26 15:44:45 -0400746 func_echo "$gh_cmd auth logout ${logout_args[*]} <<< 'Y'"
Joey Armstrong78cecc52023-04-03 11:39:11 -0400747 "$gh_cmd" auth logout "${logout_args[@]}" <<< 'Y'
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400748
749 unset active_login
750 return
751}
752
753## -----------------------------------------------------------------------
754## Intent: Query for repository version strings
755## -----------------------------------------------------------------------
756function get_releases()
757{
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400758 declare -n refA="$1"; shift
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400759
760 banner ""
761 pushd "$scratch" >/dev/null
Joey Armstrong76026b72023-03-29 12:19:17 -0400762
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400763 # gh api repos/{owner}/{repo}/releases
764 local releases_uri
765 get_gh_releases releases_uri
Joey Armstrongf9a0a882023-04-17 11:53:57 -0400766 # declare -p releases_uri
Joey Armstrong76026b72023-03-29 12:19:17 -0400767
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400768 refA=()
Joey Armstronge8560da2023-04-26 15:44:45 -0400769 "$gh_cmd" api "$releases_uri" | jq . > 'release.raw'
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400770 readarray -t __tmp < <(jq '.[] | "\(.tag_name)"' 'release.raw')
771
772 local release
773 for release in "${__tmp[@]}";
774 do
Joey Armstrong43c48422023-04-03 10:17:32 -0400775 release="${release//\"/}"
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400776 refA+=("$release")
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400777 done
778
779 popd >/dev/null
780 return
781}
782
783## -----------------------------------------------------------------------
784## Intent: Display repository query strings.
785## Indirect: verify authentication and API
786## -----------------------------------------------------------------------
787function showReleases()
788{
Joey Armstrong43c48422023-04-03 10:17:32 -0400789 declare -a raw=()
790 get_releases raw
791
792 ## Sort for display, we may need to prune volume later on
Joey Armstronge8560da2023-04-26 15:44:45 -0400793 readarray -t releases < <(sort -nr <<<"${raw[*]}")
794 # IFS=$'\n' releases=($(sort -nr <<<"${raw[*]}"))
795 # unset IFS
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400796
797 local release
798 for release in "${releases[@]}";
799 do
Joey Armstrong43c48422023-04-03 10:17:32 -0400800 func_echo "$release"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400801 done
802 return
803}
804
805## -----------------------------------------------------------------------
806## Intent: Install the gh command line tool locally
Joey Armstrong26707f02023-01-26 12:41:12 -0500807## -----------------------------------------------------------------------
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500808function install_gh_binary()
Joey Armstrong26707f02023-01-26 12:41:12 -0500809{
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400810 banner
Joey Armstrong26707f02023-01-26 12:41:12 -0500811
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500812 pushd "$scratch"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400813 func_echo "Retrieve latest gh download URLs"
Joey Armstrongf085d872023-01-28 17:52:29 -0500814
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500815 local latest="https://github.com/cli/cli/releases/latest"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400816 local tarball="gh.tar.tgz"
817
Joey Armstrong76026b72023-03-29 12:19:17 -0400818 readarray -t latest < <(\
819 curl --silent -qI "$latest" \
Joey Armstrong43c48422023-04-03 10:17:32 -0400820 | awk -F '/' '/^location/ {print substr($NF, 1, length($NF)-1)}')
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400821 declare -p latest
822 if [ ${#latest[@]} -ne 1 ]; then
Joey Armstrong43c48422023-04-03 10:17:32 -0400823 error "Unable to determine latest gh package version"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400824 fi
Joey Armstrong76026b72023-03-29 12:19:17 -0400825
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400826 local VER="${latest[0]}"
827
828 func_echo "Download latest gh binary"
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500829 local url="https://github.com/cli/cli/releases/download/${VER}/gh_${VER#v}_linux_amd64.tar.gz"
Joey Armstrong43c48422023-04-03 10:17:32 -0400830 func_echo "wget --quiet --output-document='$tarball' '$url'"
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500831 wget --quiet --output-document="$tarball" "$url"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400832
833 func_echo "Unpack tarball"
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500834 tar zxf "$tarball"
835
Joey Armstrong78cecc52023-04-03 11:39:11 -0400836 declare -g gh_cmd
837 gh_cmd="$(find "${scratch}" -name 'gh' -print)"
838 #declare -g gh_cmd='/usr/bin/gh'
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500839 readonly gh_cmd
840
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400841 func_echo "Command: ${gh_cmd}"
842 func_echo "Version: $("$gh_cmd" --version)"
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500843 popd
844
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400845 return
846}
847
848## -----------------------------------------------------------------------
849## Intent: Danger Will Robinson
850## -----------------------------------------------------------------------
851function releaseDelete()
852{
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400853 declare -n refA=$1; shift
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400854 local version="$1"; shift
Joey Armstrong76026b72023-03-29 12:19:17 -0400855
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400856 banner "${refA[@]}"
857 # declare -a refA=()
858 refA+=('--host-repo')
859 refA+=('--yes')
860 # refA+=('--cleanup-tag')
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400861
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400862 echo
863 echo "==========================================================================="
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400864 my_gh 'release' 'delete' "$version" "${refA[@]}"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400865 echo "==========================================================================="
866 echo
867
868 showReleases
869 return
870}
871
872## -----------------------------------------------------------------------
873## Intent: Copy binaries into temp/release, checksum then publish
874## -----------------------------------------------------------------------
875function release_staging()
876{
877 local release_temp
878 get_release_dir release_temp
879
880 banner ''
881 func_echo "Packaging release files"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400882
Joey Armstrong76026b72023-03-29 12:19:17 -0400883 pushd "$release_temp" >/dev/null \
Joey Armstrong43c48422023-04-03 10:17:32 -0400884 || error "pushd failed: dir is [$release_temp]"
Joey Armstrong76026b72023-03-29 12:19:17 -0400885
886 declare -a to_release=()
887 get_artifacts '.' to_release
888
Joey Armstrong55fe80e2023-04-05 18:32:14 -0400889 if false; then
Joey Armstrongf9a0a882023-04-17 11:53:57 -0400890 for fyl in "${to_release[@]}";
891 do
892 func_echo "sha256sum $fyl > ${fyl}.sha256"
893 sha256sum "$fyl" > "${fyl}.sha256"
894 done
Joey Armstrong55fe80e2023-04-05 18:32:14 -0400895 fi
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400896
897 # Generate and check checksums
Joey Armstrong55fe80e2023-04-05 18:32:14 -0400898 sha256sum -- * | grep -iv -e 'checksum' -e 'sha256' > checksum.SHA256
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400899 sha256sum -c < checksum.SHA256
900
901 echo
902 func_echo "Checksums(checksum.SHA256):"
903 cat checksum.SHA256
904
Joey Armstrong43c48422023-04-03 10:17:32 -0400905 if false; then
Joey Armstrong78cecc52023-04-03 11:39:11 -0400906 # Careful with credentials display
Joey Armstrong43c48422023-04-03 10:17:32 -0400907 get_gh_hostname login_args
Joey Armstronge8560da2023-04-26 15:44:45 -0400908 banner "gh auth status ${login_args[*]}"
Joey Armstrong43c48422023-04-03 10:17:32 -0400909 gh auth status "${login_args[@]}"
910 fi
911
Joey Armstrong76026b72023-03-29 12:19:17 -0400912 gh_release_create # publish
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400913
914 popd >/dev/null || error "pushd failed: dir is [$release_temp]"
915
916 return
917}
918
919## -----------------------------------------------------------------------
Joey Armstrong43c48422023-04-03 10:17:32 -0400920## Intent: Normalize common arguments and access to the gh command.
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400921## o Cache path to the gh command
922## o Construct a gh command line from given args
923## o Command wrapper can provide defaults (--hostname github.com)
924## -----------------------------------------------------------------------
925## Given:
926## scalar Array variable name (declare -n is a reference)
927## Return:
928## ref gh command line passed back to caller
929## Switches:
930## --host Pass default github hostname
Joey Armstrong01e4edb2023-08-18 12:50:32 -0400931## --verbose Enable verbose mode
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400932## --version Display command version
933## @array Remaining arguments passed as command switches.
934## -----------------------------------------------------------------------
935## See Also:
936## o https://cli.github.com/manual
937## -----------------------------------------------------------------------
938function my_gh()
939{
Joey Armstrong73bb2f62023-04-17 19:31:50 -0400940 func_echo "ENTER"
941 set -x
942
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400943 declare -a cmd=()
944 cmd+=("$gh_cmd")
945
946 ## ----------------------
947 ## Construct command line
948 ## ----------------------
949 # shellcheck disable=SC2034
950 declare -A action=() # pending operations
951 declare -a args=() # common gh command line args
952
953 while [ $# -gt 0 ]; do
954 local arg="$1"; shift
Joey Armstrong73bb2f62023-04-17 19:31:50 -0400955 func_echo "function arg is [$arg]"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400956 case "$arg" in
957
Joey Armstrong43c48422023-04-03 10:17:32 -0400958 # Modes
Joey Armstronge8560da2023-04-26 15:44:45 -0400959 -*debug)
960 # shellcheck disable=SC2034
961 declare -i -g debug=1
962 ;;
963 -*verbose) args+=('--verbose') ;;
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400964
Joey Armstrong43c48422023-04-03 10:17:32 -0400965 -*hostname)
966 get_gh_hostname in_args
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400967 ;;
968
Joey Armstrong43c48422023-04-03 10:17:32 -0400969 --host-repo)
970 local val
971 get_argv_repo val
Joey Armstrong76026b72023-03-29 12:19:17 -0400972
Joey Armstrong43c48422023-04-03 10:17:32 -0400973 # --repo <[HOST/]OWNER/REPO>
Joey Armstrong78cecc52023-04-03 11:39:11 -0400974 args+=('--repo' "${__githost}/${val}")
Joey Armstrong43c48422023-04-03 10:17:32 -0400975 ;;
Joey Armstrong76026b72023-03-29 12:19:17 -0400976
Joey Armstrongf9a0a882023-04-17 11:53:57 -0400977# args+=('--repo' 'github.com/opencord/bbsim')
978
Joey Armstrong43c48422023-04-03 10:17:32 -0400979 --repo)
980 local val
981 get_argv_repo val
982 args+=('--repo' "$val")
983 ;;
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400984
Joey Armstrong43c48422023-04-03 10:17:32 -0400985 --tag)
986 local val
987 get_argv_tag val
Joey Armstrong4dbe7002023-04-04 12:47:38 -0400988 args+=("$val") # No switch, pass inline
Joey Armstrong43c48422023-04-03 10:17:32 -0400989 ;;
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400990
Joey Armstrong43c48422023-04-03 10:17:32 -0400991 --title)
992 local val
993 get_argv_name val
Joey Armstrongf9a0a882023-04-17 11:53:57 -0400994 args+=('--title' "'$val'")
Joey Armstrong43c48422023-04-03 10:17:32 -0400995 ;;
Joey Armstrong76026b72023-03-29 12:19:17 -0400996
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400997 *) args+=("$arg") ;;
998 esac
999 done
Joey Armstrong76026b72023-03-29 12:19:17 -04001000
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001001 cmd+=("${args[@]}")
Joey Armstrong73bb2f62023-04-17 19:31:50 -04001002
1003 echo
1004 declare -p cmd
1005
1006 echo
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001007 echo "** Running: ${cmd[*]}"
1008 "${cmd[@]}"
1009 local status=$?
1010
Joey Armstrong73bb2f62023-04-17 19:31:50 -04001011 set +x
1012 func_echo "LEAVE"
1013
Joey Armstronge8560da2023-04-26 15:44:45 -04001014 if [[ $status -eq 0 ]]; then
1015 true
1016 else
1017 false
1018 fi
1019
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001020 return
1021}
1022
1023## ---------------------------------------------------------------------------
1024## Intent:
1025## ---------------------------------------------------------------------------
1026function usage()
1027{
1028 cat <<EOH
Joey Armstrong76026b72023-03-29 12:19:17 -04001029
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001030Usage: $0
1031Usage: make [options] [target] ...
1032 --help This mesage
Joey Armstrong55fe80e2023-04-05 18:32:14 -04001033 --pac Personal Access Token (path to containing file or a string)
1034 --repo-name ex: voltctl
1035 --repo-org ex: opencord
Joey Armstronge8560da2023-04-26 15:44:45 -04001036 --release-notes [f] Release notes are passed by file argument
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001037
1038[DEBUG]
1039 --gen-version Generate a random release version string.
1040 --git-hostname Git server hostname (default=github.com)
Joey Armstrong55fe80e2023-04-05 18:32:14 -04001041 --version-file Read version string from local version file (vs env var)
Joey Armstrongf9a0a882023-04-17 11:53:57 -04001042
1043[MODES]
Joey Armstrong55fe80e2023-04-05 18:32:14 -04001044 --debug Enable script debug mode
1045 --draft Create a draft release (vs published)
Joey Armstrong43c48422023-04-03 10:17:32 -04001046 --dry-run Simulation mode
Joey Armstrong55fe80e2023-04-05 18:32:14 -04001047 --todo Display future enhancement list
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001048
Joey Armstronge8560da2023-04-26 15:44:45 -04001049All other arguments are pass-through to the gh command.
1050
Joey Armstrong55fe80e2023-04-05 18:32:14 -04001051Usage: $0 --draft --repo-org opencord --repo-name voltctl --git-hostname github.com --pac ~/access.pac
Joey Armstronge8560da2023-04-26 15:44:45 -04001052
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001053EOH
Joey Armstronge8560da2023-04-26 15:44:45 -04001054
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001055 return
1056}
1057
1058## ---------------------------------------------------------------------------
1059## Intent: Parse script command line arguments
1060## ---------------------------------------------------------------------------
1061function parse_args()
1062{
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001063 [[ -v DEBUG ]] && func_echo "ENTER"
1064
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001065 while [ $# -gt 0 ]; do
Joey Armstrong43c48422023-04-03 10:17:32 -04001066 local arg="$1"; shift
1067 func_echo "ARGV: $arg"
Joey Armstrong01e4edb2023-08-18 12:50:32 -04001068
1069 # shellcheck disable=SC2034
Joey Armstrong43c48422023-04-03 10:17:32 -04001070 case "$arg" in
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001071
Joey Armstrong43c48422023-04-03 10:17:32 -04001072 -*debug) declare -i -g debug=1 ;;
1073 --draft) declare -i -g draft_release=1 ;;
1074 --dry-run) declare -i -g dry_run=1 ;;
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001075
Joey Armstrong43c48422023-04-03 10:17:32 -04001076 --version-file)
1077 declare -i -g argv_version_file=1
1078 ;;
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001079
Joey Armstrong43c48422023-04-03 10:17:32 -04001080 -*gen-version)
1081 declare -g -i argv_gen_version=1
1082 ;;
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001083
Joey Armstrong43c48422023-04-03 10:17:32 -04001084 -*git-hostname)
1085 __githost="$1"; shift
1086 ;;
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001087
Joey Armstrong55fe80e2023-04-05 18:32:14 -04001088 -*release-notes)
Joey Armstronge8560da2023-04-26 15:44:45 -04001089 [[ ! -f "$1" ]] && error "--release-notes: file path required (arg=\"$arg\")"
1090 declare -g release_notes="$1"; shift
Joey Armstrongf9a0a882023-04-17 11:53:57 -04001091 ;;
Joey Armstrong55fe80e2023-04-05 18:32:14 -04001092
Joey Armstrong43c48422023-04-03 10:17:32 -04001093 -*repo-name)
1094 __repo_name="$1"; shift
1095 ;;
1096
1097 -*repo-org)
1098 __repo_org="$1"; shift
1099 ;;
1100
1101 -*pac)
1102 declare -g pac="$1"; shift
1103 readonly pac
1104 [[ ! -f "$pac" ]] && error "--token= does not exist ($pac)"
1105 : # nop/true
1106 ;;
1107
1108 -*todo) todo ;;
1109
1110 -*help)
1111 usage
1112 exit 0
1113 ;;
1114
1115 *) error "Detected unknown argument $arg" ;;
1116 esac
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001117 done
1118
Joey Armstrong26707f02023-01-26 12:41:12 -05001119 return
1120}
1121
Joey Armstrongaf577ab2022-12-15 14:43:33 -05001122##----------------##
1123##---] MAIN [---##
1124##----------------##
Joey Armstrong1962bcf2023-01-27 13:53:18 -05001125iam="${0##*/}"
1126
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001127full_banner
Joey Armstronge8560da2023-04-26 15:44:45 -04001128parse_args "$@"
Joey Armstrongd99e3d22023-01-29 12:35:43 -05001129init
1130install_gh_binary
Joey Armstrong7f382ef2023-01-25 12:00:08 -05001131
Joey Armstrong01e4edb2023-08-18 12:50:32 -04001132do_login "$*"
Zack Williams27cd3e52018-09-18 16:44:50 -07001133
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001134release_path='/dev/null'
1135get_release_path release_path
1136declare -p release_path
Zack Williams27cd3e52018-09-18 16:44:50 -07001137
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001138pushd "$release_path" || error "pushd failed: dir is [$release_path]"
Zack Williams27cd3e52018-09-18 16:44:50 -07001139
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001140 # legacy: getGitVersion "$GERRIT_PROJECT" GIT_VERSION
1141 getGitVersion GIT_VERSION
1142 getReleaseDescription RELEASE_DESCRIPTION
Joey Armstrong55fe80e2023-04-05 18:32:14 -04001143 if [[ ! -v release_notes ]]; then
Joey Armstronge8560da2023-04-26 15:44:45 -04001144 func_echo "Generating release notes from RELEASE_DESCRIPTION"
Joey Armstrongf9a0a882023-04-17 11:53:57 -04001145 declare -g release_notes="$scratch/release.notes"
1146 echo "$RELEASE_DESCRIPTION" > "$release_notes"
Joey Armstrong55fe80e2023-04-05 18:32:14 -04001147 fi
Joey Armstronge8560da2023-04-26 15:44:45 -04001148 cat "$release_notes"
Zack Williams27cd3e52018-09-18 16:44:50 -07001149
Joey Armstrongeef8c2c2023-03-27 17:27:43 -04001150 cat <<EOM
1151
1152** -----------------------------------------------------------------------
1153** GIT VERSION: $(declare -p GIT_VERSION)
1154** RELEASE_DESCRIPTION: $(declare -p RELEASE_DESCRIPTION)
1155** RELEASE_TARGETS: $(declare -p RELEASE_TARGETS)
Joey Armstrong43c48422023-04-03 10:17:32 -04001156** -----------------------------------------------------------------------
Joey Armstronge8560da2023-04-26 15:44:45 -04001157** URL: https://github.com/opencord/bbsim/releases
1158** -----------------------------------------------------------------------
Joey Armstrong43c48422023-04-03 10:17:32 -04001159** Running: make ${RELEASE_TARGETS}
Joey Armstrongeef8c2c2023-03-27 17:27:43 -04001160** -----------------------------------------------------------------------
1161EOM
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001162 # build the release, can be multiple space separated targets
1163 # -----------------------------------------------------------------------
1164 # % go build command-line-arguments:
1165 # copying /tmp/go-build4212845548/b001/exe/a.out:
1166 # open release/voltctl-1.8.25-linux-amd64: permission denied
1167 # missing: docker run mkdir
1168 # -----------------------------------------------------------------------
1169 # shellcheck disable=SC2086
Joey Armstrongeef8c2c2023-03-27 17:27:43 -04001170 make "$RELEASE_TARGETS"
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001171 copyToRelease
Joey Armstrong50f6e0b2023-01-24 14:14:08 -05001172
Joey Armstrong26707f02023-01-26 12:41:12 -05001173 cat <<EOM
Joey Armstrong1962bcf2023-01-27 13:53:18 -05001174
1175** -----------------------------------------------------------------------
1176** Create the release:
1177** 1) Create initial github release with download area.
1178** 2) Generate checksum.SHA256 for all released files.
1179** 3) Upload files to complete the release.
Joey Armstrong75a0d932023-03-28 08:59:54 -04001180** 4) Display released info from github
Joey Armstrong1962bcf2023-01-27 13:53:18 -05001181** -----------------------------------------------------------------------
Joey Armstrong26707f02023-01-26 12:41:12 -05001182EOM
1183
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001184 showReleases
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001185 release_staging
Joey Armstronge8560da2023-04-26 15:44:45 -04001186
1187 # Useful to display but --draft images use a non-standard subdir identifier.
1188 # showReleaseUrl
1189
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001190 popd || error "pushd failed: dir is [$release_path]"
Joey Armstrong28eddda2023-01-10 03:09:34 -05001191
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001192do_logout
1193
Joey Armstrong28eddda2023-01-10 03:09:34 -05001194# [SEE ALSO]
1195# -----------------------------------------------------------------------
1196# https://www.shellcheck.net/wiki/SC2236
Joey Armstrong26707f02023-01-26 12:41:12 -05001197# https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#create-a-release
Joey Armstrong28eddda2023-01-10 03:09:34 -05001198# -----------------------------------------------------------------------
Joey Armstrongf085d872023-01-28 17:52:29 -05001199# https://cli.github.com/manual/gh_help_reference
1200# https://cli.github.com/manual/gh_release
1201# -----------------------------------------------------------------------
Joey Armstrong28eddda2023-01-10 03:09:34 -05001202
1203# [EOF]