actions/forgejo-release
0
0
Fork 0
mirror of https://code.forgejo.org/actions/forgejo-release.git synced 2025-10-13 16:11:56 +03:00
Code Issues Projects Releases Packages Wiki Activity

Refactor bash-isms and use POSIX sh where applicable

Browse source
This commit is contained in:
Jack Greiner 2025-10-09 16:37:07 -04:00
parent 1d79e86315
commit 324005b6c0
No known key found for this signature in database
GPG key ID: F34343A8F6B33E1E
2 changed files with 97 additions and 93 deletions
Download patch file Download diff file Expand all files Collapse all files

101
forgejo-release.sh
View file

@ -1,4 +1,4 @@
#!/bin/bash #!/usr/bin/env sh
# SPDX-License-Identifier: MIT # SPDX-License-Identifier: MIT
set -e set -e
@ -27,9 +27,7 @@ TAG_URL=$(echo "$TAG" | sed 's/\//%2F/g')
export GNUPGHOME export GNUPGHOME
get_arch() { get_arch() {
local arch arch=$(uname -m)
arch="$(uname -m)"
case "$arch" in case "$arch" in
x86_64) arch="amd64" ;; x86_64) arch="amd64" ;;
i386|i686) arch="i386" ;; i386|i686) arch="i386" ;;
@ -47,28 +45,28 @@ get_arch() {
setup_tea() { setup_tea() {
if command -v tea >/dev/null 2>&1; then if command -v tea >/dev/null 2>&1; then
TEA_BIN=$(command -v tea) TEA_BIN=$(command -v tea)
elif ! test -f $TEA_BIN; then elif ! [ -f "$TEA_BIN" ]; then
ARCH=$(get_arch) ARCH=$(get_arch)
curl -sL https://dl.gitea.io/tea/$TEA_VERSION/tea-$TEA_VERSION-linux-"$ARCH" >$TEA_BIN curl -sL "https://dl.gitea.io/tea/$TEA_VERSION/tea-$TEA_VERSION-linux-$ARCH" >"$TEA_BIN"
chmod +x $TEA_BIN chmod +x "$TEA_BIN"
fi fi
} }
get_tag() { get_tag() {
if ! test -f "$TAG_FILE"; then if ! [ -f "$TAG_FILE" ]; then
if api GET repos/$REPO/tags/"$TAG_URL" >"$TAG_FILE"; then if api GET repos/$REPO/tags/"$TAG_URL" >"$TAG_FILE"; then
echo "tag $TAG exists" echo "tag $TAG exists"
else else
echo "tag $TAG does not exists" echo "tag $TAG does not exists"
fi fi
fi fi
test -s "$TAG_FILE" [ -s "$TAG_FILE" ]
} }
matched_tag() { matched_tag() {
if get_tag; then if get_tag; then
local sha=$(jq --raw-output .commit.sha <"$TAG_FILE") sha=$(jq --raw-output .commit.sha <"$TAG_FILE")
test "$sha" = "$SHA" [ "$sha" = "$SHA" ]
else else
return 1 return 1
fi fi
@ -101,22 +99,23 @@ upload_release() {
# assets is defined as a list of arguments, where values may contain whitespace and need to be quoted like this -a "my file.txt" -a "file.txt". # assets is defined as a list of arguments, where values may contain whitespace and need to be quoted like this -a "my file.txt" -a "file.txt".
# It is expanded using "${assets[@]}" which preserves the separation of arguments and not split whitespace containing values. # It is expanded using "${assets[@]}" which preserves the separation of arguments and not split whitespace containing values.
# For reference, see https://github.com/koalaman/shellcheck/wiki/SC2086#exceptions # For reference, see https://github.com/koalaman/shellcheck/wiki/SC2086#exceptions
local assets=() set --
for file in "$RELEASE_DIR"/*; do for file in "$RELEASE_DIR"/*; do
assets=("${assets[@]}" -a "$file") set -- "$@" -a "$file"
done done
if $PRERELEASE || echo "${TAG}" | grep -qi '\-rc'; then releaseType=""
if ${PRERELEASE:-false} || echo "$TAG" | grep -qi -- '-rc'; then
releaseType="--prerelease" releaseType="--prerelease"
echo "Uploading as Pre-Release" echo "Uploading as Pre-Release"
else else
echo "Uploading as Stable" echo "Uploading as Stable"
fi fi
ensure_tag ensure_tag
if ! $TEA_BIN release create "${assets[@]}" --repo $REPO --note "$RELEASENOTES" --tag "$TAG" --title "$TITLE" --draft ${releaseType} >&"$TMP_DIR"/tea.log; then if ! "$TEA_BIN" release create "$@" --repo "$REPO" --note "$RELEASENOTES" --tag "$TAG" --title "$TITLE" --draft ${releaseType} >"$TMP_DIR"/tea.log 2>&1; then
if grep --quiet 'Unknown API Error: 500' "$TMP_DIR"/tea.log && grep --quiet services/release/release.go:194 "$TMP_DIR"/tea.log; then if grep --quiet 'Unknown API Error: 500' "$TMP_DIR"/tea.log && grep --quiet 'services/release/release.go:194' "$TMP_DIR"/tea.log; then
echo "workaround v1.20 race condition https://codeberg.org/forgejo/forgejo/issues/1370" echo "workaround v1.20 race condition https://codeberg.org/forgejo/forgejo/issues/1370"
sleep 10 sleep 10
$TEA_BIN release create "${assets[@]}" --repo $REPO --note "$RELEASENOTES" --tag "$TAG" --title "$TITLE" --draft ${releaseType} "$TEA_BIN" release create "$@" --repo "$REPO" --note "$RELEASENOTES" --tag "$TAG" --title "$TITLE" --draft ${releaseType}
else else
cat "$TMP_DIR"/tea.log cat "$TMP_DIR"/tea.log
return 1 return 1
@ -127,47 +126,45 @@ upload_release() {
} }
release_draft() { release_draft() {
local state="$1" state="$1"
rid=$(api GET repos/$REPO/releases/tags/"$TAG_URL" | jq --raw-output .id)
local id=$(api GET repos/$REPO/releases/tags/"$TAG_URL" | jq --raw-output .id) api PATCH repos/$REPO/releases/"$rid" --data-raw '{"draft": '"$state"', "hide_archive_links": '"$HIDE_ARCHIVE_LINK"'}'
api PATCH repos/$REPO/releases/"$id" --data-raw '{"draft": '"$state"', "hide_archive_links": '$HIDE_ARCHIVE_LINK'}'
} }
maybe_use_release_note_assistant() { maybe_use_release_note_assistant() {
if "$RELEASE_NOTES_ASSISTANT"; then if ${RELEASE_NOTES_ASSISTANT:-false}; then
curl --fail -s -S -o rna https://code.forgejo.org/forgejo/release-notes-assistant/releases/download/$RELEASE_NOTES_ASSISTANT_VERSION/release-notes-assistant curl --fail -s -S -o rna "https://code.forgejo.org/forgejo/release-notes-assistant/releases/download/$RELEASE_NOTES_ASSISTANT_VERSION/release-notes-assistant"
chmod +x ./rna chmod +x ./rna
mkdir -p $RELEASE_NOTES_ASSISTANT_WORKDIR mkdir -p "$RELEASE_NOTES_ASSISTANT_WORKDIR"
./rna --workdir=$RELEASE_NOTES_ASSISTANT_WORKDIR --storage release --storage-location "$TAG" --token "$TOKEN" --forgejo-url "$SCHEME://$HOST" --repository $REPO --token "$TOKEN" release "$TAG" ./rna --workdir="$RELEASE_NOTES_ASSISTANT_WORKDIR" --storage release --storage-location "$TAG" --token "$TOKEN" --forgejo-url "$SCHEME://$HOST" --repository "$REPO" --token "$TOKEN" release "$TAG"
fi fi
} }
sign_release() { sign_release() {
local passphrase passphrase=""
if test -s "$GPG_PASSPHRASE"; then if [ -s "$GPG_PASSPHRASE" ]; then
passphrase="--passphrase-file $GPG_PASSPHRASE" passphrase="--passphrase-file $GPG_PASSPHRASE"
fi fi
gpg --import --no-tty --pinentry-mode loopback $passphrase "$GPG_PRIVATE_KEY" gpg --import --no-tty --pinentry-mode loopback $passphrase "$GPG_PRIVATE_KEY"
for asset in "$RELEASE_DIR"/*; do for asset in "$RELEASE_DIR"/*; do
if [[ $asset =~ .sha256$ ]]; then case "$asset" in
continue *.sha256) continue ;;
fi esac
gpg --armor --detach-sign --no-tty --pinentry-mode loopback $passphrase <"$asset" >"$asset".asc gpg --armor --detach-sign --no-tty --pinentry-mode loopback $passphrase <"$asset" >"$asset".asc
done done
} }
maybe_sign_release() { maybe_sign_release() {
if test -s "$GPG_PRIVATE_KEY"; then if [ -s "$GPG_PRIVATE_KEY" ]; then
sign_release sign_release
fi fi
} }
maybe_override() { maybe_override() {
if test "$OVERRIDE" = "false"; then if [ "$OVERRIDE" = "false" ]; then
return return
fi fi
api DELETE repos/$REPO/releases/tags/"$TAG_URL" >&/dev/null || true api DELETE repos/$REPO/releases/tags/"$TAG_URL" >/dev/null 2>&1 || true
if get_tag && ! matched_tag; then if get_tag && ! matched_tag; then
delete_tag delete_tag
fi fi
@ -176,8 +173,8 @@ maybe_override() {
upload() { upload() {
setup_api setup_api
setup_tea setup_tea
rm -f ~/.config/tea/config.yml rm -f "$HOME/.config/tea/config.yml"
GITEA_SERVER_TOKEN=$TOKEN $TEA_BIN login add --url $FORGEJO GITEA_SERVER_TOKEN=$TOKEN "$TEA_BIN" login add --url "$FORGEJO"
maybe_sign_release maybe_sign_release
maybe_override maybe_override
upload_release upload_release
@ -207,14 +204,15 @@ api() {
path=$1 path=$1
shift shift
curl --fail -X "$method" -sS -H "Content-Type: application/json" -H "Authorization: token $TOKEN" "$@" $FORGEJO/api/v1/"$path" curl --fail -X "$method" -sS -H "Content-Type: application/json" -H "Authorization: token $TOKEN" "$@" "$FORGEJO/api/v1/$path"
} }
wait_release() { wait_release() {
local ready=false ready=false
for i in $(seq $RETRY); do i=1
while [ "$i" -le "$RETRY" ]; do
if api GET repos/$REPO/releases/tags/"$TAG_URL" | jq --raw-output .draft >"$TMP_DIR"/draft; then if api GET repos/$REPO/releases/tags/"$TAG_URL" | jq --raw-output .draft >"$TMP_DIR"/draft; then
if test "$(cat "$TMP_DIR"/draft)" = "false"; then if [ "$(cat "$TMP_DIR"/draft)" = "false" ]; then
ready=true ready=true
break break
fi fi
@ -223,9 +221,10 @@ wait_release() {
echo "release $TAG does not exist yet" echo "release $TAG does not exist yet"
fi fi
echo "waiting $DELAY seconds" echo "waiting $DELAY seconds"
sleep $DELAY sleep "$DELAY"
i=$((i+1))
done done
if ! $ready; then if [ "$ready" != "true" ]; then
echo "no release for $TAG" echo "no release for $TAG"
return 1 return 1
fi fi
@ -234,17 +233,17 @@ wait_release() {
download() { download() {
setup_api setup_api
( (
mkdir -p $RELEASE_DIR mkdir -p "$RELEASE_DIR"
cd $RELEASE_DIR cd "$RELEASE_DIR" || exit 1
if [[ ${DOWNLOAD_LATEST} == "true" ]]; then if [ "${DOWNLOAD_LATEST}" = "true" ]; then
echo "Downloading the latest release" echo "Downloading the latest release"
api GET repos/$REPO/releases/latest >"$TMP_DIR"/assets.json api GET repos/$REPO/releases/latest >"$TMP_DIR"/assets.json
elif [[ ${DOWNLOAD_LATEST} == "false" ]]; then elif [ "${DOWNLOAD_LATEST}" = "false" ]; then
wait_release wait_release
echo "Downloading tagged release ${TAG}" echo "Downloading tagged release ${TAG}"
api GET repos/$REPO/releases/tags/"$TAG_URL" >"$TMP_DIR"/assets.json api GET repos/$REPO/releases/tags/"$TAG_URL" >"$TMP_DIR"/assets.json
fi fi
jq --raw-output '.assets[] | "\(.browser_download_url) \(.name)"' <"$TMP_DIR"/assets.json | while read url name; do # `name` may contain whitespace, therefore, it must be last jq --raw-output '.assets[] | "\(.browser_download_url) \(.name)"' <"$TMP_DIR"/assets.json | while read url name; do
url=$(echo "$url" | sed "s#/download/${TAG}/#/download/${TAG_URL}/#") url=$(echo "$url" | sed "s#/download/${TAG}/#/download/${TAG_URL}/#")
curl --fail -H "Authorization: token $TOKEN" -o "$name" -L "$url" curl --fail -H "Authorization: token $TOKEN" -o "$name" -L "$url"
done done
@ -252,8 +251,12 @@ download() {
} }
missing() { missing() {
echo need upload or download argument got nothing echo "need upload or download argument got nothing"
exit 1 exit 1
} }
${@:-missing} if [ "$#" -gt 0 ]; then
"$@"
else
missing
fi

89
testdata/forgejo-release-test.sh vendored
View file

@ -1,21 +1,22 @@
#!/bin/bash #!/usr/bin/env sh
# SPDX-License-Identifier: MIT # SPDX-License-Identifier: MIT
set -ex set -ex
PS4='${BASH_SOURCE[0]}:$LINENO: ${FUNCNAME[0]}: ' PS4='${0##*/}:$LINENO: '
test_system_tea_bin() { test_system_tea_bin() {
SYSTEM_TEA_BIN=$TMP_DIR/tea SYSTEM_TEA_BIN=$TMP_DIR/tea
touch $SYSTEM_TEA_BIN && chmod +x $SYSTEM_TEA_BIN : >"$SYSTEM_TEA_BIN" && chmod +x "$SYSTEM_TEA_BIN"
export PATH=$TMP_DIR:$PATH PATH=$TMP_DIR:$PATH
export PATH
setup_tea setup_tea
test $TEA_BIN == $SYSTEM_TEA_BIN [ "$TEA_BIN" = "$SYSTEM_TEA_BIN" ]
} }
test_download_tea_bin() { test_download_tea_bin() {
# assume tea is not installed on system # assume tea is not installed on system
setup_tea setup_tea
test $TEA_BIN == $TMP_DIR/tea [ "$TEA_BIN" = "$TMP_DIR/tea" ]
} }
test_teardown() { test_teardown() {
@ -24,23 +25,23 @@ test_teardown() {
api DELETE repos/$REPO/tags/$TAG || true api DELETE repos/$REPO/tags/$TAG || true
rm -fr dist/release rm -fr dist/release
setup_tea setup_tea
$TEA_BIN login delete $DOER || true "$TEA_BIN" login delete "$DOER" || true
} }
test_reset_repo() { test_reset_repo() {
local project="$1" project="$1"
api DELETE repos/$REPO || true api DELETE repos/$REPO || true
api POST user/repos --data-raw '{"name":"'$project'", "auto_init":true}' api POST user/repos --data-raw '{"name":"'$project'", "auto_init":true}'
git clone $FORGEJO/$REPO $TMP_DIR/repo git clone "$FORGEJO/$REPO" "$TMP_DIR/repo"
SHA=$(git -C $TMP_DIR/repo rev-parse HEAD) SHA=$(git -C "$TMP_DIR/repo" rev-parse HEAD)
} }
test_setup() { test_setup() {
local project="$1" project="$1"
test_reset_repo $project test_reset_repo "$project"
mkdir -p $RELEASE_DIR mkdir -p "$RELEASE_DIR"
touch $RELEASE_DIR/file-one.txt : >"$RELEASE_DIR/file-one.txt"
touch $RELEASE_DIR/file-two.txt : >"$RELEASE_DIR/file-two.txt"
} }
test_wait_release_fail() { test_wait_release_fail() {
@ -69,12 +70,12 @@ test_ensure_tag() {
# idempotent # idempotent
# #
ensure_tag ensure_tag
mv $TAG_FILE $TMP_DIR/tag1.json mv "$TAG_FILE" "$TMP_DIR/tag1.json"
ensure_tag ensure_tag
mv $TAG_FILE $TMP_DIR/tag2.json mv "$TAG_FILE" "$TMP_DIR/tag2.json"
diff -u $TMP_DIR/tag[12].json diff -u "$TMP_DIR/tag1.json" "$TMP_DIR/tag2.json"
# #
# sanity check on the SHA of an existing tag # sanity check on the SHA of an existing tag
# #
@ -92,7 +93,7 @@ test_maybe_sign_release_no_gpg() {
GPG_PRIVATE_KEY= GPG_PRIVATE_KEY=
maybe_sign_release maybe_sign_release
! test -f $RELEASE_DIR/file-one.txt.asc ! [ -f "$RELEASE_DIR/file-one.txt.asc" ]
} }
test_maybe_sign_release_gpg_no_passphrase() { test_maybe_sign_release_gpg_no_passphrase() {
@ -117,28 +118,28 @@ test_maybe_sign_release_gpg() {
} }
test_maybe_sign_release_skipped() { test_maybe_sign_release_skipped() {
! test -f $RELEASE_DIR/file-one.txt.sha256.asc ! [ -f "$RELEASE_DIR/file-one.txt.sha256.asc" ]
! test -f $RELEASE_DIR/file-two.txt.sha256.asc ! [ -f "$RELEASE_DIR/file-two.txt.sha256.asc" ]
} }
test_maybe_sign_release_verify() { test_maybe_sign_release_verify() {
for file in $RELEASE_DIR/file-one.txt $RELEASE_DIR/file-two.txt; do for file in "$RELEASE_DIR/file-one.txt" "$RELEASE_DIR/file-two.txt"; do
gpg --verify $file.asc $file gpg --verify "$file.asc" "$file"
done done
} }
test_maybe_sign_release_setup() { test_maybe_sign_release_setup() {
local name="$1" name="$1"
echo "========= maybe_sign_release $name =========" echo "========= maybe_sign_release $name ========="
RELEASE_DIR=$TMP_DIR/$name RELEASE_DIR="$TMP_DIR/$name"
mkdir -p $RELEASE_DIR mkdir -p "$RELEASE_DIR"
GNUPGHOME=$TMP_DIR/$name/.gnupg GNUPGHOME="$TMP_DIR/$name/.gnupg"
mkdir -p $GNUPGHOME mkdir -p "$GNUPGHOME"
touch $RELEASE_DIR/file-one.txt : >"$RELEASE_DIR/file-one.txt"
touch $RELEASE_DIR/file-one.txt.sha256 : >"$RELEASE_DIR/file-one.txt.sha256"
touch $RELEASE_DIR/file-two.txt : >"$RELEASE_DIR/file-two.txt"
touch $RELEASE_DIR/file-two.txt.sha256 : >"$RELEASE_DIR/file-two.txt.sha256"
} }
test_maybe_sign_release() { test_maybe_sign_release() {
@ -148,31 +149,31 @@ test_maybe_sign_release() {
} }
test_run() { test_run() {
local user="$1" user="$1"
local project="$2" project="$2"
test_teardown test_teardown
to_push=$TMP_DIR/binaries-releases-to-push to_push="$TMP_DIR/binaries-releases-to-push"
pulled=$TMP_DIR/binaries-releases-pulled pulled="$TMP_DIR/binaries-releases-pulled"
RELEASE_DIR=$to_push RELEASE_DIR="$to_push"
REPO=$user/$project REPO="$user/$project"
test_setup $project test_setup "$project"
test_ensure_tag test_ensure_tag
test_create_delete_tag test_create_delete_tag
DELAY=0 DELAY=0
test_wait_release_fail test_wait_release_fail
echo "================================ TEST BEGIN" echo "================================ TEST BEGIN"
upload upload
RELEASE_DIR=$pulled RELEASE_DIR="$pulled"
download download
diff -r $to_push $pulled diff -r "$to_push" "$pulled"
echo "================================ TEST END" echo "================================ TEST END"
test_wait_release test_wait_release
} }
TMP_DIR=$(mktemp -d) TMP_DIR=$(mktemp -d)
trap "rm -fr $TMP_DIR" EXIT trap 'rm -fr "$TMP_DIR"' 0 INT TERM
: ${TAG:=v17.8.20-1} : ${TAG:=v17.8.20-1}
. $(dirname $0)/../forgejo-release.sh . "$(dirname "$0")/../forgejo-release.sh"