blob: a7d412c395a662cf51994162ad64611453ff472e [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 Armstrong43c48422023-04-03 10:17:32 -040036# declare -i -g gen_version=1
Joey Armstrong78cecc52023-04-03 11:39:11 -040037# declare -i -g draft_release=1
Joey Armstrong43c48422023-04-03 10:17:32 -040038
Joey Armstrong41923cc2023-01-30 14:38:16 -050039# declare -g TRACE=0 # uncomment to set -x
40
41# shellcheck disable=SC2015
42[[ -v TRACE ]] && { set -x; } || { set +x; } # SC2015 (shellcheck -x)
43
Joey Armstrong2097d3e2023-03-26 10:32:03 -040044declare -a -g ARGV=() # Capture args to minimize globals and arg passing
45[[ $# -gt 0 ]] && ARGV=("$@")
Joey Armstrongd99e3d22023-01-29 12:35:43 -050046
47declare -g scratch # temp workspace for downloads
Joey Armstrongd99e3d22023-01-29 12:35:43 -050048
Joey Armstrong78cecc52023-04-03 11:39:11 -040049declare -g SCRIPT_VERSION='1.3' # git changeset needed
Joey Armstrong26707f02023-01-26 12:41:12 -050050
Joey Armstrong7f382ef2023-01-25 12:00:08 -050051##--------------------##
52##---] INCLUDES [---##
Joey Armstrong1962bcf2023-01-27 13:53:18 -050053##--------------------#
Joey Armstrong2097d3e2023-03-26 10:32:03 -040054
55## -----------------------------------------------------------------------
56## Intent: Register an interrupt handler to display a stack trace on error
57## -----------------------------------------------------------------------
58function errexit()
59{
60 local err=$?
61 set +o xtrace
62 local code="${1:-1}"
63
64 local prefix="${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
65 echo -e "\nOFFENDER: ${prefix}"
66 if [ $# -gt 0 ] && [ "$1" == '--stacktrace-quiet' ]; then
67 code=1
68 else
69 echo "ERROR: '${BASH_COMMAND}' exited with status $err"
70 fi
71
72 # Print out the stack trace described by $function_stack
73 if [ ${#FUNCNAME[@]} -gt 2 ]
74 then
Joey Armstrong43c48422023-04-03 10:17:32 -040075 echo "Call tree:"
76 for ((i=1;i<${#FUNCNAME[@]}-1;i++))
77 do
78 echo " $i: ${BASH_SOURCE[$i+1]}:${BASH_LINENO[$i]} ${FUNCNAME[$i]}(...)"
79 done
Joey Armstrong2097d3e2023-03-26 10:32:03 -040080 fi
81
82 echo "Exiting with status ${code}"
83 echo
84 exit "${code}"
85 # return
86}
87
88# trap ERR to provide an error handler whenever a command exits nonzero
89# this is a more verbose version of set -o errexit
90trap errexit ERR
91
92# setting errtrace allows our ERR trap handler to be propagated to functions,
93# expansions and subshells
94set -o errtrace
Joey Armstrong7f382ef2023-01-25 12:00:08 -050095
96## -----------------------------------------------------------------------
Joey Armstrongd99e3d22023-01-29 12:35:43 -050097## Intent: Cleanup scratch area on exit
98## -----------------------------------------------------------------------
99function sigtrap()
100{
101 ## Prevent mishaps
102 local is_read_only
103 is_read_only="$(declare -p scratch)"
104 if [[ $is_read_only != *"declare -r scratch="* ]]; then
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400105 echo "ERROR: variable scratch is not read-only, cleanup skipped"
106 exit 1
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500107 fi
108
109 if [ -d "$scratch" ]; then
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400110 /bin/rm -fr "$scratch"
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500111 fi
112
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400113 do_logout
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500114 return
115}
116trap sigtrap EXIT
117
118## -----------------------------------------------------------------------
Joey Armstrongad7b1e02023-03-27 11:55:48 -0400119## Intent: Return a release version for queries
120## Note: Do not use in production, function is intended for interactive use
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400121## -----------------------------------------------------------------------
122function get_version()
123{
124 declare -n ref="$1"
125
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400126 declare -a rev=()
127 rev+=("$(( RANDOM % 10 + 1 ))")
128 rev+=("$(( RANDOM % 256 + 1 ))")
Joey Armstrongeef8c2c2023-03-27 17:27:43 -0400129 rev+=("$(( RANDOM % 10000 + 1 ))")
Joey Armstrongfc20ed52023-04-03 19:37:58 -0400130 local ver="v${rev[0]}.${rev[1]}.${rev[2]}"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400131
Joey Armstrong43c48422023-04-03 10:17:32 -0400132 func_echo "VERSION: $ver"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400133 ref="$ver"
134 return
135}
136
137## -----------------------------------------------------------------------
138## Intent: Provide defaults for environment variables
139## -----------------------------------------------------------------------
140function initEnvVars()
141{
142 # when not running under Jenkins, use current dir as workspace and a blank
143 # project name
144 declare -g WORKSPACE=${WORKSPACE:-.}
145 declare -g GERRIT_PROJECT=${GERRIT_PROJECT:-}
Joey Armstrong76026b72023-03-29 12:19:17 -0400146
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400147 # Github organization (or user) this project is published on. Project name should
148 # be the same on both Gerrit and GitHub
Joey Armstrong76026b72023-03-29 12:19:17 -0400149 declare -g GITHUB_ORGANIZATION=${GITHUB_ORGANIZATION:-}
150
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400151 # glob pattern relative to project dir matching release artifacts
152 # ARTIFACT_GLOB=${ARTIFACT_GLOB:-"release/*"} # stat -- release/* not found, literal string (?)
153 declare -g ARTIFACT_GLOB=${ARTIFACT_GLOB:-"release/."}
Joey Armstrong76026b72023-03-29 12:19:17 -0400154
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400155 # Use "release" as the default makefile target, can be a space separated list
156 declare -g RELEASE_TARGETS=${RELEASE_TARGETS:-release}
Joey Armstrong76026b72023-03-29 12:19:17 -0400157
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400158 # Set and handle GOPATH and PATH
159 export GOPATH=${GOPATH:-$WORKSPACE/go}
160 export PATH=$PATH:/usr/lib/go-1.12/bin:/usr/local/go/bin:$GOPATH/bin
161 return
162}
163
164## -----------------------------------------------------------------------
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500165## Intent: Create a scratch area for downloads and transient tools
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400166## temp directory will be automatically removed upon exit.
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500167## -----------------------------------------------------------------------
168function init()
169{
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500170 local pkgbase="${0##*/}" # basename
171 local pkgname="${pkgbase%.*}"
172
Joey Armstrongad7b1e02023-03-27 11:55:48 -0400173 # initEnvVars # moved to full_banner()
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400174
175 ## Create a temp directory for auto-cleanup
176 declare -g scratch
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500177 scratch="$(mktemp -d -t "${pkgname}.XXXXXXXXXX")"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400178 readonly scratch
179 declare -p scratch
180
Joey Armstrong43c48422023-04-03 10:17:32 -0400181 ## prime the stream: cache answers
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400182 local work
183 get_release_dir work
184 declare -p work
Joey Armstrong43c48422023-04-03 10:17:32 -0400185
186 local filler
187 getGitVersion filler
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 Armstrongca557dc2023-04-03 17:12:32 -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 Armstrongca557dc2023-04-03 17:12:32 -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 Armstrongca557dc2023-04-03 17:12:32 -0400290 local path="$GERRIT_PROJECT"
291 pushd "$path" || error "pushd GERRIT_PROJECT= failed $(declare -p path)"
Joey Armstrong43c48422023-04-03 10:17:32 -0400292 __ver="$(git tag -l --points-at HEAD)"
Joey Armstrongca557dc2023-04-03 17:12:32 -0400293 popd || error "popd GERRIT_PROJECT= failed"
Joey Armstrong43c48422023-04-03 10:17:32 -0400294 fi
Joey Armstrong76026b72023-03-29 12:19:17 -0400295
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400296 # ------------------------------------------------------
297 # match bare versions or v-prefixed golang style version
298 # Critical failure for new/yet-to-be-released repo ?
299 # ------------------------------------------------------
Joey Armstrong43c48422023-04-03 10:17:32 -0400300 if [[ "$__ver" =~ ^v?([0-9]+)\.([0-9]+)\.([0-9]+)$ ]]; then
Joey Armstrongfc20ed52023-04-03 19:37:58 -0400301 echo "git has a SemVer released version tag: '$__ver'"
Joey Armstrong43c48422023-04-03 10:17:32 -0400302 echo "Building artifacts for GitHub release."
303
304 elif [[ "$__ver" =~ ^v?([0-9]+)\.([0-9]+)\.([0-9]+)-dev([0-9]+)$ ]]; then
305 declare -i -g draft_release=1
306 echo "Detected --draft SemVer release version tag [$__ver]"
307 echo "Building artifacts for GitHub release."
308
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400309 else
Joey Armstrong43c48422023-04-03 10:17:32 -0400310 error "No SemVer released version tag found, exiting..."
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400311 fi
312
Joey Armstrong43c48422023-04-03 10:17:32 -0400313 ## Cache value for subsequent calls.
314 ## readonly is a guarantee assignment happens once.
315 declare -g cached_getGitVersion="$__ver"
316 readonly cached_getGitVersion;
317
318 varname="$__ver"
319 func_echo "Version is [$__ver] from $(/bin/pwd)"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400320 return
321}
322
323## -----------------------------------------------------------------------
324## Intent:
325## Note: Release description is sanitized version of the log message
326## -----------------------------------------------------------------------
327function getReleaseDescription()
328{
329 declare -n varname="$1"; shift
330
331 local msg
332 msg="$(git log -1 --pretty=%B)"
333
334 local val
335 val="$(tr -dc "[:alnum:]\n\r\.\[\]\:\-\\\/\`\' " <<< "$msg")"
336
337 [[ ${#val} -eq 0 ]] && error "Release Description is empty ($msg)"
338 varname="$val"
339 return
340}
341
342## -----------------------------------------------------------------------
343## Intent: Retrieve value of the release temp directory.
344## -----------------------------------------------------------------------
345## Note: Limit use of globals so logic can be isolated in function calls.
346## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400347function get_release_dir()
348{
349 declare -n varname=$1; shift
350
351 # Temporary staging directory to copy artifacts to
352 varname="$scratch/release"
353 mkdir -p "$varname"
354 return
355}
356
357## -----------------------------------------------------------------------
358## Intent: Retrieve github server hostname
359## -----------------------------------------------------------------------
360function get_gh_hostname()
361{
362 declare -n varname=$1; shift
363 varname+=('--hostname' "${__githost}")
364 return
365}
366
367## -----------------------------------------------------------------------
368## Intent: Retrieve repository organizaiton name
369## -----------------------------------------------------------------------
370function get_gh_repo_org()
371{
372 declare -n varname=$1; shift
373 declare -g __repo_org
Joey Armstrong76026b72023-03-29 12:19:17 -0400374
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400375 local org
376 if [[ -v __repo_org ]]; then
Joey Armstrong43c48422023-04-03 10:17:32 -0400377 org="$__repo_org"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400378 elif [[ ! -v GITHUB_ORGANIZATION ]]; then
Joey Armstrong43c48422023-04-03 10:17:32 -0400379 error "--repo-org or GITHUB_ORGANIZATION= are required"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400380 else
Joey Armstrong43c48422023-04-03 10:17:32 -0400381 org="${GITHUB_ORGANIZATION}"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400382 fi
383
384 # shellcheck disable=SC2178
385 varname="$org"
386 return
387}
388
389## -----------------------------------------------------------------------
390## Intent: Retrieve repository organizaiton name
391## -----------------------------------------------------------------------
392function get_gh_repo_name()
393{
394 declare -n varname=$1; shift
395 declare -g __repo_name
Joey Armstrong76026b72023-03-29 12:19:17 -0400396
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400397 local name
398 if [[ -v __repo_name ]]; then
Joey Armstrong43c48422023-04-03 10:17:32 -0400399 name="$__repo_name"
Joey Armstrong39fac652023-03-27 18:50:43 -0400400 elif [[ ! -v GERRIT_PROJECT ]]; then
Joey Armstrong43c48422023-04-03 10:17:32 -0400401 error "--repo-name or GERRIT_PROJECT= are required"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400402 else
Joey Armstrong43c48422023-04-03 10:17:32 -0400403 name="${GERRIT_PROJECT}"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400404 fi
405
406 varname="$name"
407 return
408}
409
410## -----------------------------------------------------------------------
411## Intent: Return path for the gh release query
412## -----------------------------------------------------------------------
413function get_gh_releases()
414{
415 declare -n ref="$1"
416
417 local repo_org
418 get_gh_repo_org repo_org
419
420 local repo_name
421 get_gh_repo_name repo_name
422
423 ref="repos/${repo_org}/${repo_name}/releases"
424 func_echo "ref=$ref"
425 return
426}
427
428## -----------------------------------------------------------------------
429## Intent: Retrieve repository path argument
430## -----------------------------------------------------------------------
431function get_argv_repo()
432{
433 declare -n varname=$1; shift
434
435 local repo_org
436 get_gh_repo_org repo_org
Joey Armstrong76026b72023-03-29 12:19:17 -0400437
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400438 local repo_name
Joey Armstrong76026b72023-03-29 12:19:17 -0400439 get_gh_repo_name repo_name
440
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400441 varname="${repo_org}/${repo_name}"
Joey Armstrong43c48422023-04-03 10:17:32 -0400442 # func_echo "VARNAME=$varname"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400443 return
444}
445
446## -----------------------------------------------------------------------
447## Intent: Retrieve release name string "project - version"
448## -----------------------------------------------------------------------
449function get_argv_name()
450{
451 declare -n varname=$1; shift
452
453 local repo_name
454 get_gh_repo_name repo_name
Joey Armstrong43c48422023-04-03 10:17:32 -0400455
456 local repo_ver
457 getGitVersion repo_ver
458
459 # varname="${repo_name} - $GIT_VERSION"
460 varname="${repo_name} - ${repo_ver}"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400461 func_echo "varname=$varname"
462 return
463}
464
465## -----------------------------------------------------------------------
466## Intent: Retrieve tag version
467## -----------------------------------------------------------------------
468function get_argv_tag()
469{
470 declare -n varname=$1; shift
471
472 # cached_argv_tag='v3.41.3204'
473 if [[ ! -v cached_argv_tag ]]; then
Joey Armstrong43c48422023-04-03 10:17:32 -0400474 declare -g cached_argv_tag
475 if [[ -v GIT_VERSION ]]; then # hello jenkins
476 cached_argv_tag="$GIT_VERSION"
477 fi
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400478 fi
479
480 [[ ${#cached_argv_tag} -eq 0 ]] && error "Unable to determine GIT_VERSION="
481 varname="$cached_argv_tag"
482 func_echo "varname=$varname"
483 return
484}
485
486## -----------------------------------------------------------------------
487## Intent:
488## -----------------------------------------------------------------------
489# To support golang projects that require GOPATH to be set and code checked out there
490# If $DEST_GOPATH is not an empty string:
491# - create GOPATH within WORKSPACE, and destination directory within
492# - set PATH to include $GOPATH/bin and the system go binaries
493# - move project from $WORKSPACE/$GERRIT_PROJECT to new location in $GOPATH
494# - start release process within that directory
495## -----------------------------------------------------------------------
496function get_release_path()
497{
498 declare -n varname=$1; shift
499
500 DEST_GOPATH=${DEST_GOPATH:-}
501 if [ -n "$DEST_GOPATH" ]; then
Joey Armstrong43c48422023-04-03 10:17:32 -0400502 mkdir -p "$GOPATH/src/$DEST_GOPATH"
503 varname="$GOPATH/src/$DEST_GOPATH/$GERRIT_PROJECT"
504 mv "$WORKSPACE/$GERRIT_PROJECT" "$varname"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400505 else
Joey Armstrong43c48422023-04-03 10:17:32 -0400506 varname="$WORKSPACE/$GERRIT_PROJECT"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400507 fi
508
Joey Armstrong43c48422023-04-03 10:17:32 -0400509 ## Verify pwd is OK
510 for path in \
511 "$varname/Makefile"\
512 "$varname/makefile"\
513 "__ERROR__"\
514 ; do
515 case "$path" in
516 __ERROR__) error "Makefile not found at $varname!" ;;
517 *) [[ -f "$path" ]] && break ;;
518 esac
519 done
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400520
521 return
522}
523
524## -----------------------------------------------------------------------
525## Intent: Display future enhancements
526## -----------------------------------------------------------------------
527function todo()
528{
529 local iam="${0##*/}"
530
531cat <<EOT
532
533** -----------------------------------------------------------------------
534** IAM: ${iam} :: ${FUNCNAME[0]}
535** -----------------------------------------------------------------------
536 o get_release_path()
537 - refactor redundant paths into local vars.
538 - see comments, do we have a one-off failure condition ?
Joey Armstrongad7b1e02023-03-27 11:55:48 -0400539 o PATH += golang appended 3 times, release needs a single, reliable answer.
540 o do_login, do_logout and api calls do not use the my_gh wrapper:
541 - Add a lookup function to cache and retrieve path to downloaded gh command.
Joey Armstrong76026b72023-03-29 12:19:17 -0400542
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400543EOT
544
545 return
546}
547
548## -----------------------------------------------------------------------
Joey Armstrong76026b72023-03-29 12:19:17 -0400549## Intent: Verify a directory contains content for release.
550## -----------------------------------------------------------------------
551## Given:
552## scalar Path to release/ directory
553## ref Results returned through this indirect var.
554## -----------------------------------------------------------------------
555## Usage:
556## declare -a artifacts=()
557## get_artifacts '/foo/bar/tans' artifacts
558## declare -p artifacts
559## -----------------------------------------------------------------------
560function get_artifacts()
561{
562 local dir="$1" ; shift
563 declare -n ref=$1 ; shift
564
565 # Glob available files
566 readarray -t __artifacts < <(find "$dir" -mindepth 1 ! -type d)
567 func_echo "$(declare -p __artifacts)"
568
569 # -----------------------------------------------------------------------
570 # Verify count>0 to inhibit source-only release
571 # Problem children:
572 # o build or make release failures.
573 # o docker container filesystem mount problem (~volume)
574 # -----------------------------------------------------------------------
575 [[ ${#__artifacts[@]} -eq 0 ]] \
Joey Armstrong43c48422023-04-03 10:17:32 -0400576 && error "Artifact dir is empty: $(declare -p dir)"
Joey Armstrong76026b72023-03-29 12:19:17 -0400577
578 ref=("${__artifacts[@]}")
579 return
580}
581
582## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400583## Intent: Copy files from the build directory into the release staging
584## directory for publishing to github releases/ endpoint.
Joey Armstrong26707f02023-01-26 12:41:12 -0500585## -----------------------------------------------------------------------
586function copyToRelease()
587{
Joey Armstrong76026b72023-03-29 12:19:17 -0400588 banner ''
Joey Armstrong26707f02023-01-26 12:41:12 -0500589
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400590 local artifact_glob="${ARTIFACT_GLOB%/*}"
591 func_echo "$(declare -p artifact_glob)"
592
593 local work
594 get_release_dir work
Joey Armstrong76026b72023-03-29 12:19:17 -0400595 func_echo "Artifact dir: $(declare -p work)"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400596
Joey Armstrong76026b72023-03-29 12:19:17 -0400597 ## Verify release content is available
598 declare -a artifacts=()
Joey Armstrong43c48422023-04-03 10:17:32 -0400599 # get_artifacts "$work" artifacts
600 get_artifacts "$artifact_glob" artifacts
601 func_echo "Artifacts in copy_from: $(declare -p artifacts)"
Joey Armstrong472bfba2023-03-27 18:12:28 -0400602
Joey Armstrong26707f02023-01-26 12:41:12 -0500603 # Copy artifacts into the release temp dir
604 # shellcheck disable=SC2086
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400605 echo "rsync -rv --checksum \"$artifact_glob/.\" \"$work/.\""
606 rsync -rv --checksum "$artifact_glob/." "$work/."
Joey Armstrong1962bcf2023-01-27 13:53:18 -0500607
Joey Armstrong43c48422023-04-03 10:17:32 -0400608 get_artifacts "$work" artifacts
609 func_echo "Artifacts in copy_to: $(declare -p artifacts)"
610
Joey Armstrong26707f02023-01-26 12:41:12 -0500611 return
612}
613
614## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400615## https://docs.github.com/en/rest/releases?apiVersion=2022-11-28
616 # https://cli.github.com/manual/gh_release_create
617 # --target <branch> or commit SHA
618 # --title
619 # --generate-notes
620 # --release-notes (notes file)
621 # --release
622 # release create dist/*.tgz
623 # --discussion-category "General"
Joey Armstrongf085d872023-01-28 17:52:29 -0500624## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400625# https://cli.github.com/manual/gh_release_create
626## -----------------------------------------------------------------------
627function gh_release_create()
Joey Armstrong38bfeea2023-02-06 18:01:29 -0500628{
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400629 banner ''
Joey Armstrong38bfeea2023-02-06 18:01:29 -0500630
Joey Armstrong43c48422023-04-03 10:17:32 -0400631 local version
632 getGitVersion version
Joey Armstrong38bfeea2023-02-06 18:01:29 -0500633
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400634 local work
635 get_release_dir work
636
Joey Armstrong43c48422023-04-03 10:17:32 -0400637 declare -a args=()
638 args+=('--host-repo')
639 args+=('--title')
640 if [[ -v draft_release ]]; then
641 args+=('--draft')
642 else
643 args+=('--discussion-category' 'Announcements')
644 fi
645
646 # args+=('--notes' "'Testing release create -- ignore'")
647
Joey Armstrong78cecc52023-04-03 11:39:11 -0400648 pushd "$work/.." >/dev/null
649 func_echo "WORK=$work"
650 # readarray -t payload < <(find '.' -maxdepth 4 ! -type d -print)
651 readarray -t payload < <(find 'release' -maxdepth 4 ! -type d -print)
Joey Armstrong76026b72023-03-29 12:19:17 -0400652
Joey Armstrongad7b1e02023-03-27 11:55:48 -0400653 func_echo "$gh_cmd release create ${version} ${args[@]}" "${payload[@]}"
Joey Armstrong43c48422023-04-03 10:17:32 -0400654
655 if [[ -v dry_run ]]; then
656 echo "[SKIP] dry run"
657 else
Joey Armstrong78cecc52023-04-03 11:39:11 -0400658 func_echo "my_gh release create '$version' ${args[@]} ${payload[@]}"
Joey Armstrong4dbe7002023-04-04 12:47:38 -0400659 my_gh 'release' 'create' "$version" "${args[@]}" "${payload[@]}"
Joey Armstrong43c48422023-04-03 10:17:32 -0400660 set +x
661 fi
Joey Armstrong76026b72023-03-29 12:19:17 -0400662 popd >/dev/null
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400663
Joey Armstrong38bfeea2023-02-06 18:01:29 -0500664 return
665}
666
667## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400668## Intent: Authenticate credentials for a github gh session
Joey Armstrong38bfeea2023-02-06 18:01:29 -0500669## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400670## NOTE: my_gh currently unused due to --with-token < "$pac"
671## -----------------------------------------------------------------------
672function do_login()
Joey Armstrongf085d872023-01-28 17:52:29 -0500673{
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400674 declare -g pac
Joey Armstrong485081f2023-03-27 13:34:08 -0400675 declare -a login_args=()
676 [[ $# -gt 0 ]] && login_args+=("$@")
Joey Armstrongf085d872023-01-28 17:52:29 -0500677
Joey Armstrong485081f2023-03-27 13:34:08 -0400678 # https://github.com/cli/cli/issues/2922#issuecomment-775027762
Joey Armstrong75a0d932023-03-28 08:59:54 -0400679 # (sigh) why not quietly return VS forcing a special logic path
Joey Armstronge6e18eb2023-03-27 14:19:21 -0400680 # [[ -v WORKSPACE ]] && [[ -v GITHUB_TOKEN ]] && return
681
682# 12:58:36 ** -----------------------------------------------------------------------
683# 12:58:36 ** jenkins582353203049151829.sh::do_login: --hostname github.com
684# 12:58:36 ** --------------------------------------------------------------------# ---
685# 12:58:36 ** jenkins582353203049151829.sh :: do_login: Detected ENV{GITHUB_TOKEN}=
686# 12:58:36 The value of the GITHUB_TOKEN environment variable is being used for authentication.
687# 12:58:36 To have GitHub CLI store credentials instead, first clear the value from the environment.
Joey Armstrong43c48422023-04-03 10:17:32 -0400688# -----------------------------------------------------------------------
Joey Armstrong76026b72023-03-29 12:19:17 -0400689
Joey Armstrong485081f2023-03-27 13:34:08 -0400690 get_gh_hostname login_args
Joey Armstrongf085d872023-01-28 17:52:29 -0500691
Joey Armstrong485081f2023-03-27 13:34:08 -0400692 banner "${login_args[@]}"
Joey Armstrong78cecc52023-04-03 11:39:11 -0400693 func_echo "$(declare -p WORKSPACE)"
Joey Armstrongf085d872023-01-28 17:52:29 -0500694
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400695 ## Read from disk is safer than export GITHUB_TOKEN=
696 if [[ -v pac ]] && [[ ${#pac} -gt 0 ]]; then # interactive/debugging
Joey Armstrong43c48422023-04-03 10:17:32 -0400697 [ ! -f "$pac" ] && error "PAC token file $pac does not exist"
Joey Armstrong78cecc52023-04-03 11:39:11 -0400698 func_echo "$gh_cmd auth login ${login_args[@]} --with-token < $pac"
Joey Armstrong485081f2023-03-27 13:34:08 -0400699 "$gh_cmd" auth login "${login_args[@]}" --with-token < "$pac"
Joey Armstrongf085d872023-01-28 17:52:29 -0500700
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400701 elif [[ ! -v GITHUB_TOKEN ]]; then
702 error "--token [t] or GITHUB_TOKEN= are required"
Joey Armstrong41923cc2023-01-30 14:38:16 -0500703
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400704 else # jenkins
Joey Armstrong78cecc52023-04-03 11:39:11 -0400705 func_echo "$gh_cmd auth login ${login_args[@]} (ie: jenkins)"
Joey Armstrong733ea9f2023-04-03 21:19:46 -0400706
707 # https://github.com/cli/cli/issues/2922#issuecomment-775027762
708 # When using GITHUB_TOKEN, there is no need to even run gh auth logi
709 # "$gh_cmd" auth login "${login_args[@]}"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400710 fi
Joey Armstrongf085d872023-01-28 17:52:29 -0500711
Joey Armstrong43c48422023-04-03 10:17:32 -0400712 declare -i -g active_login=1 # signal logout needed
Joey Armstrongf085d872023-01-28 17:52:29 -0500713
Joey Armstrongf085d872023-01-28 17:52:29 -0500714 return
715}
716
717## -----------------------------------------------------------------------
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400718## Intent: Destroy credentials/gh session authenticated by do_login
719## -----------------------------------------------------------------------
720## NOTE: my_gh currently unused due to "<<< 'y'"
721## -----------------------------------------------------------------------
722function do_logout()
723{
724 declare -i -g active_login
725 [[ ! -v active_login ]] && return
726
Joey Armstrong78cecc52023-04-03 11:39:11 -0400727 declare -a logout_args=()
728 [[ $# -gt 0 ]] && logout_args+=("$@")
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400729
Joey Armstrong78cecc52023-04-03 11:39:11 -0400730 get_gh_hostname logout_args
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400731
Joey Armstrong78cecc52023-04-03 11:39:11 -0400732 banner "${logout_args[@]}"
733 func_echo "$gh_cmd auth logout ${logout_args[@]} <<< 'Y'"
734 "$gh_cmd" auth logout "${logout_args[@]}" <<< 'Y'
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400735
736 unset active_login
737 return
738}
739
740## -----------------------------------------------------------------------
741## Intent: Query for repository version strings
742## -----------------------------------------------------------------------
743function get_releases()
744{
745 declare -n ref="$1"; shift
746 local func="${FUNCNAME[0]}"
747
748 banner ""
749 pushd "$scratch" >/dev/null
Joey Armstrong76026b72023-03-29 12:19:17 -0400750
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400751 # gh api repos/{owner}/{repo}/releases
752 local releases_uri
753 get_gh_releases releases_uri
754 declare -p releases_uri
Joey Armstrong76026b72023-03-29 12:19:17 -0400755
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400756 ref=()
Joey Armstrongad7b1e02023-03-27 11:55:48 -0400757 "$gh_cmd" api "$releases_uri" "${common[@]}" | jq . > 'release.raw'
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400758 readarray -t __tmp < <(jq '.[] | "\(.tag_name)"' 'release.raw')
759
760 local release
761 for release in "${__tmp[@]}";
762 do
Joey Armstrong43c48422023-04-03 10:17:32 -0400763 release="${release//\"/}"
764 ref+=("$release")
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400765 done
766
767 popd >/dev/null
768 return
769}
770
771## -----------------------------------------------------------------------
772## Intent: Display repository query strings.
773## Indirect: verify authentication and API
774## -----------------------------------------------------------------------
775function showReleases()
776{
Joey Armstrong43c48422023-04-03 10:17:32 -0400777 declare -a raw=()
778 get_releases raw
779
780 ## Sort for display, we may need to prune volume later on
781 IFS=$'\n' releases=($(sort -nr <<<"${raw[*]}"))
782 unset IFS
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400783
784 local release
785 for release in "${releases[@]}";
786 do
Joey Armstrong43c48422023-04-03 10:17:32 -0400787 func_echo "$release"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400788 done
789 return
790}
791
792## -----------------------------------------------------------------------
793## Intent: Install the gh command line tool locally
Joey Armstrong26707f02023-01-26 12:41:12 -0500794## -----------------------------------------------------------------------
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500795function install_gh_binary()
Joey Armstrong26707f02023-01-26 12:41:12 -0500796{
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400797 banner
Joey Armstrong26707f02023-01-26 12:41:12 -0500798
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500799 pushd "$scratch"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400800 func_echo "Retrieve latest gh download URLs"
Joey Armstrongf085d872023-01-28 17:52:29 -0500801
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500802 local latest="https://github.com/cli/cli/releases/latest"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400803 local tarball="gh.tar.tgz"
804
Joey Armstrong76026b72023-03-29 12:19:17 -0400805 readarray -t latest < <(\
806 curl --silent -qI "$latest" \
Joey Armstrong43c48422023-04-03 10:17:32 -0400807 | awk -F '/' '/^location/ {print substr($NF, 1, length($NF)-1)}')
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400808 declare -p latest
809 if [ ${#latest[@]} -ne 1 ]; then
Joey Armstrong43c48422023-04-03 10:17:32 -0400810 error "Unable to determine latest gh package version"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400811 fi
Joey Armstrong76026b72023-03-29 12:19:17 -0400812
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400813 local VER="${latest[0]}"
814
815 func_echo "Download latest gh binary"
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500816 local url="https://github.com/cli/cli/releases/download/${VER}/gh_${VER#v}_linux_amd64.tar.gz"
Joey Armstrong43c48422023-04-03 10:17:32 -0400817 func_echo "wget --quiet --output-document='$tarball' '$url'"
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500818 wget --quiet --output-document="$tarball" "$url"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400819
820 func_echo "Unpack tarball"
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500821 tar zxf "$tarball"
822
Joey Armstrong78cecc52023-04-03 11:39:11 -0400823 declare -g gh_cmd
824 gh_cmd="$(find "${scratch}" -name 'gh' -print)"
825 #declare -g gh_cmd='/usr/bin/gh'
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500826 readonly gh_cmd
827
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400828 func_echo "Command: ${gh_cmd}"
829 func_echo "Version: $("$gh_cmd" --version)"
Joey Armstrongd99e3d22023-01-29 12:35:43 -0500830 popd
831
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400832 return
833}
834
835## -----------------------------------------------------------------------
836## Intent: Danger Will Robinson
837## -----------------------------------------------------------------------
838function releaseDelete()
839{
840 local version="$1"; shift
Joey Armstrong76026b72023-03-29 12:19:17 -0400841
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400842 banner "${in_args[@]}"
843 declare -a args=()
844 args+=('--host-repo')
845 args+=('--yes')
846 # args+=('--cleanup-tag')
847
848# ** github-release.sh :: get_argv_repo: VARNAME=opencord/voltctl
849#* Running: /tmp/github-release.R7geZo7Ywo/gh_2.25.1_linux_amd64/bin/gh release delete v4.175.710 --repo 'github.com/opencord/voltctl' --yes --cleanup-tag
850#rror connecting to 'github.com
851#heck your internet connection or https://githubstatus.com
852
853 echo
854 echo "==========================================================================="
855 my_gh 'release' 'delete' "$version" "${args[@]}"
856 echo "==========================================================================="
857 echo
858
859 showReleases
860 return
861}
862
863## -----------------------------------------------------------------------
864## Intent: Copy binaries into temp/release, checksum then publish
865## -----------------------------------------------------------------------
866function release_staging()
867{
868 local release_temp
869 get_release_dir release_temp
870
871 banner ''
872 func_echo "Packaging release files"
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400873
Joey Armstrong76026b72023-03-29 12:19:17 -0400874 pushd "$release_temp" >/dev/null \
Joey Armstrong43c48422023-04-03 10:17:32 -0400875 || error "pushd failed: dir is [$release_temp]"
Joey Armstrong76026b72023-03-29 12:19:17 -0400876
877 declare -a to_release=()
878 get_artifacts '.' to_release
879
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400880 func_echo "Files to release: $(declare -p to_release)"
881
882 # Generate and check checksums
883 sha256sum -- * > checksum.SHA256
884 sha256sum -c < checksum.SHA256
885
886 echo
887 func_echo "Checksums(checksum.SHA256):"
888 cat checksum.SHA256
889
Joey Armstrong43c48422023-04-03 10:17:32 -0400890 if false; then
Joey Armstrong78cecc52023-04-03 11:39:11 -0400891 # Careful with credentials display
Joey Armstrong43c48422023-04-03 10:17:32 -0400892 get_gh_hostname login_args
893 banner "gh auth status ${login_args[@]}"
894 gh auth status "${login_args[@]}"
895 fi
896
Joey Armstrong76026b72023-03-29 12:19:17 -0400897 gh_release_create # publish
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400898
899 popd >/dev/null || error "pushd failed: dir is [$release_temp]"
900
901 return
902}
903
904## -----------------------------------------------------------------------
905## Intent: Display program usage
906## -----------------------------------------------------------------------
907function usage()
908{
909 [[ $# -gt 0 ]] && func_echo "$*"
910
911 cat <<EOH
912Usage: github-release.sh [options] [target] ...
913
914[Github CLI (gh) arguments]
915 --login Perform authentication using a PAC
916 --logout
917 --host [h] Specify github server for connection.
918
919[Options]
920 --token Login debugging, alternative to env var use.
921
922[Modes]
923 --debug Enable script debug mode
924 --verbose Enable script verbose mode
925
926All remaining arguments are passthrough to the gh command.
927EOH
928
929 exit 0
930}
931
932## -----------------------------------------------------------------------
Joey Armstrong43c48422023-04-03 10:17:32 -0400933## Intent: Normalize common arguments and access to the gh command.
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400934## o Cache path to the gh command
935## o Construct a gh command line from given args
936## o Command wrapper can provide defaults (--hostname github.com)
937## -----------------------------------------------------------------------
938## Given:
939## scalar Array variable name (declare -n is a reference)
940## Return:
941## ref gh command line passed back to caller
942## Switches:
943## --host Pass default github hostname
944## --verbose Enable verbose mode#
945## --version Display command version
946## @array Remaining arguments passed as command switches.
947## -----------------------------------------------------------------------
948## See Also:
949## o https://cli.github.com/manual
950## -----------------------------------------------------------------------
951function my_gh()
952{
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400953 declare -a cmd=()
954 cmd+=("$gh_cmd")
955
956 ## ----------------------
957 ## Construct command line
958 ## ----------------------
959 # shellcheck disable=SC2034
960 declare -A action=() # pending operations
961 declare -a args=() # common gh command line args
962
963 while [ $# -gt 0 ]; do
964 local arg="$1"; shift
965 case "$arg" in
966
Joey Armstrong43c48422023-04-03 10:17:32 -0400967 # Modes
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400968 -*debug) declare -i -g debug=1 ;;
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400969 -*verbose) args+=('--verbose') ;;
970
Joey Armstrong43c48422023-04-03 10:17:32 -0400971 -*hostname)
972 get_gh_hostname in_args
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400973 ;;
974
Joey Armstrong43c48422023-04-03 10:17:32 -0400975 --host-repo)
976 local val
977 get_argv_repo val
Joey Armstrong76026b72023-03-29 12:19:17 -0400978
Joey Armstrong43c48422023-04-03 10:17:32 -0400979 # --repo <[HOST/]OWNER/REPO>
Joey Armstrong78cecc52023-04-03 11:39:11 -0400980 args+=('--repo' "${__githost}/${val}")
Joey Armstrong43c48422023-04-03 10:17:32 -0400981 ;;
Joey Armstrong76026b72023-03-29 12:19:17 -0400982
Joey Armstrong43c48422023-04-03 10:17:32 -0400983 --repo)
984 local val
985 get_argv_repo val
986 args+=('--repo' "$val")
987 ;;
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400988
Joey Armstrong43c48422023-04-03 10:17:32 -0400989 --tag)
990 local val
991 get_argv_tag val
Joey Armstrong4dbe7002023-04-04 12:47:38 -0400992 args+=("$val") # No switch, pass inline
Joey Armstrong43c48422023-04-03 10:17:32 -0400993 ;;
Joey Armstrong2097d3e2023-03-26 10:32:03 -0400994
Joey Armstrong43c48422023-04-03 10:17:32 -0400995 --title)
996 local val
997 get_argv_name val
Joey Armstrong4dbe7002023-04-04 12:47:38 -0400998 args+=('--title' "$val")
Joey Armstrong43c48422023-04-03 10:17:32 -0400999 ;;
Joey Armstrong76026b72023-03-29 12:19:17 -04001000
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001001 *) args+=("$arg") ;;
1002 esac
1003 done
Joey Armstrong76026b72023-03-29 12:19:17 -04001004
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001005 cmd+=("${args[@]}")
1006 echo "** Running: ${cmd[*]}"
1007 "${cmd[@]}"
1008 local status=$?
1009
1010 [[ $status -eq 0 ]] && { true; } || { false; }
1011 return
1012}
1013
1014## ---------------------------------------------------------------------------
1015## Intent:
1016## ---------------------------------------------------------------------------
1017function usage()
1018{
1019 cat <<EOH
Joey Armstrong76026b72023-03-29 12:19:17 -04001020
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001021Usage: $0
1022Usage: make [options] [target] ...
1023 --help This mesage
1024 --pac Personal Access Token (file)
1025
1026[DEBUG]
1027 --gen-version Generate a random release version string.
1028 --git-hostname Git server hostname (default=github.com)
Joey Armstrong43c48422023-04-03 10:17:32 -04001029 --version-file Read version string from local version file
1030
1031 --dry-run Simulation mode
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001032
1033EOH
1034 return
1035}
1036
1037## ---------------------------------------------------------------------------
1038## Intent: Parse script command line arguments
1039## ---------------------------------------------------------------------------
1040function parse_args()
1041{
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001042 [[ -v DEBUG ]] && func_echo "ENTER"
1043
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001044 while [ $# -gt 0 ]; do
Joey Armstrong43c48422023-04-03 10:17:32 -04001045 local arg="$1"; shift
1046 func_echo "ARGV: $arg"
1047 case "$arg" in
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001048
Joey Armstrong43c48422023-04-03 10:17:32 -04001049 -*debug) declare -i -g debug=1 ;;
1050 --draft) declare -i -g draft_release=1 ;;
1051 --dry-run) declare -i -g dry_run=1 ;;
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001052
Joey Armstrong43c48422023-04-03 10:17:32 -04001053 --version-file)
1054 declare -i -g argv_version_file=1
1055 ;;
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001056
Joey Armstrong43c48422023-04-03 10:17:32 -04001057 -*gen-version)
1058 declare -g -i argv_gen_version=1
1059 ;;
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001060
Joey Armstrong43c48422023-04-03 10:17:32 -04001061 -*git-hostname)
1062 __githost="$1"; shift
1063 ;;
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001064
Joey Armstrong43c48422023-04-03 10:17:32 -04001065 -*repo-name)
1066 __repo_name="$1"; shift
1067 ;;
1068
1069 -*repo-org)
1070 __repo_org="$1"; shift
1071 ;;
1072
1073 -*pac)
1074 declare -g pac="$1"; shift
1075 readonly pac
1076 [[ ! -f "$pac" ]] && error "--token= does not exist ($pac)"
1077 : # nop/true
1078 ;;
1079
1080 -*todo) todo ;;
1081
1082 -*help)
1083 usage
1084 exit 0
1085 ;;
1086
1087 *) error "Detected unknown argument $arg" ;;
1088 esac
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001089 done
1090
Joey Armstrong26707f02023-01-26 12:41:12 -05001091 return
1092}
1093
Joey Armstrongaf577ab2022-12-15 14:43:33 -05001094##----------------##
1095##---] MAIN [---##
1096##----------------##
Joey Armstrong1962bcf2023-01-27 13:53:18 -05001097iam="${0##*/}"
1098
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001099full_banner
1100parse_args $@
Joey Armstrongd99e3d22023-01-29 12:35:43 -05001101init
1102install_gh_binary
Joey Armstrong7f382ef2023-01-25 12:00:08 -05001103
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001104do_login
Zack Williams27cd3e52018-09-18 16:44:50 -07001105
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001106release_path='/dev/null'
1107get_release_path release_path
1108declare -p release_path
Zack Williams27cd3e52018-09-18 16:44:50 -07001109
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001110pushd "$release_path" || error "pushd failed: dir is [$release_path]"
Zack Williams27cd3e52018-09-18 16:44:50 -07001111
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001112 # legacy: getGitVersion "$GERRIT_PROJECT" GIT_VERSION
1113 getGitVersion GIT_VERSION
1114 getReleaseDescription RELEASE_DESCRIPTION
Zack Williams27cd3e52018-09-18 16:44:50 -07001115
Joey Armstrongeef8c2c2023-03-27 17:27:43 -04001116 cat <<EOM
1117
1118** -----------------------------------------------------------------------
1119** GIT VERSION: $(declare -p GIT_VERSION)
1120** RELEASE_DESCRIPTION: $(declare -p RELEASE_DESCRIPTION)
1121** RELEASE_TARGETS: $(declare -p RELEASE_TARGETS)
Joey Armstrong43c48422023-04-03 10:17:32 -04001122** -----------------------------------------------------------------------
1123** Running: make ${RELEASE_TARGETS}
Joey Armstrongeef8c2c2023-03-27 17:27:43 -04001124** -----------------------------------------------------------------------
1125EOM
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001126 # build the release, can be multiple space separated targets
1127 # -----------------------------------------------------------------------
1128 # % go build command-line-arguments:
1129 # copying /tmp/go-build4212845548/b001/exe/a.out:
1130 # open release/voltctl-1.8.25-linux-amd64: permission denied
1131 # missing: docker run mkdir
1132 # -----------------------------------------------------------------------
1133 # shellcheck disable=SC2086
Joey Armstrongeef8c2c2023-03-27 17:27:43 -04001134 make "$RELEASE_TARGETS"
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001135 copyToRelease
Joey Armstrong50f6e0b2023-01-24 14:14:08 -05001136
Joey Armstrong26707f02023-01-26 12:41:12 -05001137 cat <<EOM
Joey Armstrong1962bcf2023-01-27 13:53:18 -05001138
1139** -----------------------------------------------------------------------
1140** Create the release:
1141** 1) Create initial github release with download area.
1142** 2) Generate checksum.SHA256 for all released files.
1143** 3) Upload files to complete the release.
Joey Armstrong75a0d932023-03-28 08:59:54 -04001144** 4) Display released info from github
Joey Armstrong1962bcf2023-01-27 13:53:18 -05001145** -----------------------------------------------------------------------
Joey Armstrong26707f02023-01-26 12:41:12 -05001146EOM
1147
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001148 showReleases
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001149 release_staging
1150 popd || error "pushd failed: dir is [$release_path]"
Joey Armstrong43c48422023-04-03 10:17:32 -04001151# fi
Joey Armstrong28eddda2023-01-10 03:09:34 -05001152
Joey Armstrong2097d3e2023-03-26 10:32:03 -04001153do_logout
1154
Joey Armstrong28eddda2023-01-10 03:09:34 -05001155# [SEE ALSO]
1156# -----------------------------------------------------------------------
1157# https://www.shellcheck.net/wiki/SC2236
Joey Armstrong26707f02023-01-26 12:41:12 -05001158# https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#create-a-release
Joey Armstrong28eddda2023-01-10 03:09:34 -05001159# -----------------------------------------------------------------------
Joey Armstrongf085d872023-01-28 17:52:29 -05001160# https://cli.github.com/manual/gh_help_reference
1161# https://cli.github.com/manual/gh_release
1162# -----------------------------------------------------------------------
Joey Armstrong28eddda2023-01-10 03:09:34 -05001163
1164# [EOF]