mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2026-10-25 04:28:06 +09:00
296 lines
8.3 KiB
Bash
296 lines
8.3 KiB
Bash
#!/bin/sh
|
|
|
|
# AdGuard Home Release Packing Script
|
|
#
|
|
# The commentary in this file is written with the assumption that the reader
|
|
# only has superficial knowledge of the POSIX shell language and alike.
|
|
# Experienced readers may find it overly verbose.
|
|
#
|
|
# It packs the artifacts previously built by build-release.sh into archives,
|
|
# calculates their checksums, and writes the version file.
|
|
|
|
# The default verbosity level is 0. Show log messages if the caller requested
|
|
# verbosity level greater than 0. Show the environment and every command that
|
|
# is run if the verbosity level is greater than 1. Otherwise, print nothing.
|
|
verbose="${VERBOSE:-0}"
|
|
readonly verbose
|
|
|
|
if [ "$verbose" -gt '1' ]; then
|
|
env
|
|
set -x
|
|
fi
|
|
|
|
# Exit the script if a pipeline fails (-e), prevent accidental filename
|
|
# expansion (-f), and consider undefined variables as errors (-u).
|
|
set -e -o 'pipefail' -f -u
|
|
|
|
# Function log is an echo wrapper that writes to stderr if the caller requested
|
|
# verbosity level greater than 0. Otherwise, it does nothing.
|
|
log() {
|
|
if [ "$verbose" -gt '0' ]; then
|
|
# Don't use quotes to get word splitting.
|
|
printf '%s\n' "$1" 1>&2
|
|
fi
|
|
}
|
|
|
|
log 'starting to pack AdGuard Home release'
|
|
|
|
# Require the channel to be set. Additional validation is performed later by
|
|
# go-build.sh.
|
|
channel="${CHANNEL:?please set CHANNEL}"
|
|
readonly channel
|
|
|
|
# Check VERSION against the default value from the Makefile. If it is that,
|
|
# use the version calculation script.
|
|
version="${VERSION:-}"
|
|
if [ "$version" = 'v0.0.0' ] || [ "$version" = '' ]; then
|
|
version="$(sh ./scripts/make/version.sh)"
|
|
fi
|
|
readonly version
|
|
|
|
log "channel '$channel'"
|
|
log "version '$version'"
|
|
|
|
# Check architecture and OS limiters. Add spaces to the local versions for
|
|
# better pattern matching.
|
|
if [ "${ARCH:-}" != '' ]; then
|
|
log "arches: '$ARCH'"
|
|
arches=" $ARCH "
|
|
else
|
|
arches=''
|
|
fi
|
|
readonly arches
|
|
|
|
if [ "${OS:-}" != '' ]; then
|
|
log "oses: '$OS'"
|
|
oses=" $OS "
|
|
else
|
|
oses=''
|
|
fi
|
|
readonly oses
|
|
|
|
# The default distribution files directory is dist.
|
|
dist="${DIST_DIR:-dist}"
|
|
readonly dist
|
|
|
|
log 'checking tools'
|
|
|
|
# Make sure we fail gracefully if one of the tools we need is missing.
|
|
for tool in gzip tar zip; do
|
|
if ! command -v "$tool" >/dev/null; then
|
|
log "pieces don't fit, '$tool' not found"
|
|
|
|
exit 1
|
|
fi
|
|
done
|
|
|
|
# Data section. Arrange data into space-separated tables for read -r to read.
|
|
# Use a hyphen for missing values.
|
|
|
|
# os arch arm mips
|
|
platforms="\
|
|
darwin amd64 - -
|
|
darwin arm64 - -
|
|
freebsd 386 - -
|
|
freebsd amd64 - -
|
|
freebsd arm 5 -
|
|
freebsd arm 6 -
|
|
freebsd arm 7 -
|
|
freebsd arm64 - -
|
|
linux 386 - -
|
|
linux amd64 - -
|
|
linux arm 5 -
|
|
linux arm 6 -
|
|
linux arm 7 -
|
|
linux arm64 - -
|
|
linux mips - softfloat
|
|
linux mips64 - softfloat
|
|
linux mips64le - softfloat
|
|
linux mipsle - softfloat
|
|
linux ppc64le - -
|
|
linux riscv64 - -
|
|
openbsd amd64 - -
|
|
openbsd arm64 - -
|
|
windows 386 - -
|
|
windows amd64 - -
|
|
windows arm64 - -"
|
|
readonly platforms
|
|
|
|
# Function pack packs the build of a single platform into an archive.
|
|
pack() {
|
|
# Get the arguments. Here and below, use the "pack_" prefix for all
|
|
# variables local to function pack.
|
|
pack_ar="$2" \
|
|
pack_os="$3" \
|
|
;
|
|
|
|
# Make archives. Windows and macOS prefer ZIP archives; the rest,
|
|
# gzipped tarballs.
|
|
case "$pack_os" in
|
|
'darwin')
|
|
# Make the binary executable as this script may be run independently.
|
|
chmod +x "./${dist}/${1}/AdGuardHome/AdGuardHome"
|
|
|
|
pack_archive="./${dist}/${pack_ar}.zip"
|
|
|
|
# Remove the previous archive, if any, because zip updates the existing
|
|
# archives instead of recreating them.
|
|
rm -f "$pack_archive"
|
|
|
|
# TODO(a.garipov): Find an option similar to the -C option of tar for
|
|
# zip.
|
|
(cd "${dist}/${1}" && zip -9 -q -r "../../${pack_archive}" "./AdGuardHome")
|
|
;;
|
|
'windows')
|
|
# Make the binary executable as this script may be run independently.
|
|
chmod +x "./${dist}/${1}/AdGuardHome/AdGuardHome.exe"
|
|
|
|
pack_archive="./${dist}/${pack_ar}.zip"
|
|
|
|
# Remove the previous archive, if any, because zip updates the existing
|
|
# archives instead of recreating them.
|
|
rm -f "$pack_archive"
|
|
|
|
# TODO(a.garipov): Find an option similar to the -C option of tar for
|
|
# zip.
|
|
(cd "${dist}/${1}" && zip -9 -q -r "../../${pack_archive}" "./AdGuardHome")
|
|
;;
|
|
*)
|
|
# Make the binary executable as this script may be run independently.
|
|
chmod +x "./${dist}/${1}/AdGuardHome/AdGuardHome"
|
|
|
|
pack_archive="./${dist}/${pack_ar}.tar.gz"
|
|
tar -C "./${dist}/${1}" -c -f - "./AdGuardHome" | gzip -9 - >"$pack_archive"
|
|
;;
|
|
esac
|
|
|
|
log "$pack_archive"
|
|
}
|
|
|
|
log 'starting packing'
|
|
|
|
# Go over all platforms defined in the space-separated table above, tweak the
|
|
# values where necessary, and feed to pack.
|
|
echo "$platforms" | while read -r os arch arm mips; do
|
|
# See if the architecture or the OS is in the allowlist. To do so, try
|
|
# removing everything that matches the pattern (well, a prefix, but that
|
|
# doesn't matter here) containing the arch or the OS.
|
|
#
|
|
# For example, when $arches is " amd64 arm64 " and $arch is "amd64",
|
|
# then the pattern to remove is "* amd64 *", so the whole string becomes
|
|
# empty. On the other hand, if $arch is "windows", then the pattern is
|
|
# "* windows *", which doesn't match, so nothing is removed.
|
|
#
|
|
# See https://stackoverflow.com/a/43912605/1892060.
|
|
#
|
|
# shellcheck disable=SC2295
|
|
if [ "${arches##* $arch *}" != '' ]; then
|
|
log "$arch excluded, continuing"
|
|
|
|
continue
|
|
elif [ "${oses##* $os *}" != '' ]; then
|
|
log "$os excluded, continuing"
|
|
|
|
continue
|
|
fi
|
|
|
|
case "$arch" in
|
|
arm)
|
|
dir="AdGuardHome_${os}_${arch}_${arm}"
|
|
ar="AdGuardHome_${os}_${arch}v${arm}"
|
|
;;
|
|
mips*)
|
|
dir="AdGuardHome_${os}_${arch}_${mips}"
|
|
ar="$dir"
|
|
;;
|
|
*)
|
|
dir="AdGuardHome_${os}_${arch}"
|
|
ar="$dir"
|
|
;;
|
|
esac
|
|
|
|
pack "$dir" "$ar" "$os"
|
|
done
|
|
|
|
log 'packing frontend'
|
|
|
|
build_archive="./${dist}/AdGuardHome_frontend.tar.gz"
|
|
tar -c -f - ./build | gzip -9 - >"$build_archive"
|
|
log "$build_archive"
|
|
|
|
log 'calculating checksums'
|
|
|
|
env \
|
|
DIST_DIR="$dist" \
|
|
VERBOSE="$verbose" \
|
|
sh ./scripts/make/calc-checksums.sh \
|
|
;
|
|
|
|
# Create the version.json file.
|
|
|
|
version_download_url="https://static.adtidy.org/adguardhome/${channel}"
|
|
version_json="./${dist}/version.json"
|
|
readonly version_download_url version_json
|
|
|
|
# If the channel is edge, point users to the "Platforms" page on the Wiki,
|
|
# because the direct links to the edge packages are listed there.
|
|
if [ "$channel" = 'edge' ]; then
|
|
announcement_url='https://github.com/AdguardTeam/AdGuardHome/wiki/Platforms'
|
|
else
|
|
announcement_url="https://github.com/AdguardTeam/AdGuardHome/releases/tag/${version}"
|
|
fi
|
|
readonly announcement_url
|
|
|
|
# TODO(a.garipov): Remove "selfupdate_min_version" in future versions.
|
|
rm -f "$version_json"
|
|
echo "{
|
|
\"version\": \"${version}\",
|
|
\"announcement\": \"AdGuard Home ${version} is now available!\",
|
|
\"announcement_url\": \"${announcement_url}\",
|
|
\"selfupdate_min_version\": \"0.0\",
|
|
" >>"$version_json"
|
|
|
|
# Add the MIPS* object keys without the "softfloat" part to mitigate the
|
|
# consequences of #5373.
|
|
#
|
|
# TODO(a.garipov): Remove this around fall 2023.
|
|
echo "
|
|
\"download_linux_mips64\": \"${version_download_url}/AdGuardHome_linux_mips64_softfloat.tar.gz\",
|
|
\"download_linux_mips64le\": \"${version_download_url}/AdGuardHome_linux_mips64le_softfloat.tar.gz\",
|
|
\"download_linux_mipsle\": \"${version_download_url}/AdGuardHome_linux_mipsle_softfloat.tar.gz\",
|
|
" >>"$version_json"
|
|
|
|
# Same as with checksums above, don't use ls, because files matching one of the
|
|
# patterns may be absent.
|
|
ar_files="$(find "./${dist}" ! -name "${dist}" -prune \( -name '*.tar.gz' -o -name '*.zip' \))"
|
|
ar_files_len="$(echo "$ar_files" | wc -l)"
|
|
readonly ar_files ar_files_len
|
|
|
|
i='1'
|
|
# Don't use quotes to get word splitting.
|
|
for f in $ar_files; do
|
|
platform="$f"
|
|
|
|
# Remove the prefix.
|
|
platform="${platform#"./${dist}/AdGuardHome_"}"
|
|
|
|
# Remove the filename extensions.
|
|
platform="${platform%.zip}"
|
|
platform="${platform%.tar.gz}"
|
|
|
|
# Use the filename's base path.
|
|
filename="${f#"./${dist}/"}"
|
|
|
|
if [ "$i" -eq "$ar_files_len" ]; then
|
|
echo " \"download_${platform}\": \"${version_download_url}/${filename}\"" >>"$version_json"
|
|
else
|
|
echo " \"download_${platform}\": \"${version_download_url}/${filename}\"," >>"$version_json"
|
|
fi
|
|
|
|
i="$((i + 1))"
|
|
done
|
|
|
|
echo '}' >>"$version_json"
|
|
|
|
log 'finished'
|