Fix release script consistency issues

- Remove redundant git push --tags (gh release create handles tags)
- Support pre-release versions in changelog parsing
- Quote date command substitution for defensive programming
- Fix shellcheck SC2162: add -r flag to read command
- Apply shfmt formatting

Author: oschwald

dev-bin/release.sh

@@ -6,28 +6,28 @@ set -eu -o pipefail
 # before making any changes to the repository
 
 check_command() {
-    if ! command -v "$1" &> /dev/null; then
-        echo "Error: $1 is not installed or not in PATH"
-        exit 1
-    fi
+	if ! command -v "$1" &>/dev/null; then
+		echo "Error: $1 is not installed or not in PATH"
+		exit 1
+	fi
 }
 
 # Verify gh CLI is authenticated
-if ! gh auth status &> /dev/null; then
-    echo "Error: gh CLI is not authenticated. Run 'gh auth login' first."
-    exit 1
+if ! gh auth status &>/dev/null; then
+	echo "Error: gh CLI is not authenticated. Run 'gh auth login' first."
+	exit 1
 fi
 
 # Verify we can access this repository via gh
-if ! gh repo view --json name &> /dev/null; then
-    echo "Error: Cannot access repository via gh. Check your authentication and repository access."
-    exit 1
+if ! gh repo view --json name &>/dev/null; then
+	echo "Error: Cannot access repository via gh. Check your authentication and repository access."
+	exit 1
 fi
 
 # Verify git can connect to the remote (catches SSH key issues, etc.)
-if ! git ls-remote origin &> /dev/null; then
-    echo "Error: Cannot connect to git remote. Check your git credentials/SSH keys."
-    exit 1
+if ! git ls-remote origin &>/dev/null; then
+	echo "Error: Cannot connect to git remote. Check your git credentials/SSH keys."
+	exit 1
 fi
 
 check_command perl
@@ -37,54 +37,54 @@ check_command wget
 # Check that we're not on the main branch
 current_branch=$(git branch --show-current)
 if [ "$current_branch" = "main" ]; then
-    echo "Error: Releases should not be done directly on the main branch."
-    echo "Please create a release branch and run this script from there."
-    exit 1
+	echo "Error: Releases should not be done directly on the main branch."
+	echo "Please create a release branch and run this script from there."
+	exit 1
 fi
 
 # Fetch latest changes and check that we're not behind origin/main
 echo "Fetching from origin..."
 git fetch origin
 
 if ! git merge-base --is-ancestor origin/main HEAD; then
-    echo "Error: Current branch is behind origin/main."
-    echo "Please merge or rebase with origin/main before releasing."
-    exit 1
+	echo "Error: Current branch is behind origin/main."
+	echo "Please merge or rebase with origin/main before releasing."
+	exit 1
 fi
 
 phar='geoip2.phar'
 
 changelog=$(cat CHANGELOG.md)
 
 regex='
-([0-9]+\.[0-9]+\.[0-9]+) \(([0-9]{4}-[0-9]{2}-[0-9]{2})\)
+([0-9]+\.[0-9]+\.[0-9]+(-[a-zA-Z0-9.]+)?) \(([0-9]{4}-[0-9]{2}-[0-9]{2})\)
 -*
 
 ((.|
 )*)
 '
 
 if [[ ! $changelog =~ $regex ]]; then
-      echo "Could not find date line in change log!"
-      exit 1
+	echo "Could not find date line in change log!"
+	exit 1
 fi
 
 version="${BASH_REMATCH[1]}"
-date="${BASH_REMATCH[2]}"
-notes="$(echo "${BASH_REMATCH[3]}" | sed -n -e '/^[0-9]\+\.[0-9]\+\.[0-9]\+/,$!p')"
+date="${BASH_REMATCH[3]}"
+notes="$(echo "${BASH_REMATCH[4]}" | sed -n -E '/^[0-9]+\.[0-9]+\.[0-9]+(-[a-zA-Z0-9.]+)?/,$!p')"
 
-if [[ "$date" !=  $(date +"%Y-%m-%d") ]]; then
-    echo "$date is not today!"
-    exit 1
+if [[ "$date" != "$(date +"%Y-%m-%d")" ]]; then
+	echo "$date is not today!"
+	exit 1
 fi
 
 tag="v$version"
 
 rm -f "$phar"
 
 if [ -n "$(git status --porcelain)" ]; then
-    echo ". is not clean." >&2
-    exit 1
+	echo ". is not clean." >&2
+	exit 1
 fi
 
 rm -fr vendor
@@ -95,11 +95,10 @@ php composer.phar update --no-dev
 perl -pi -e "s/(?<=const VERSION = ').+?(?=';)/$tag/g" src/WebService/Client.php
 perl -pi -e "s{(?<=php composer\.phar require geoip2/geoip2:).+}{^$version}g" README.md
 
-
 box_phar_hash='f98cf885a7c07c84df66e33888f1d93f063298598e0a5f41ca322aeb9683179b  box.phar'
 
 if ! echo "$box_phar_hash" | sha256sum -c; then
-    wget -O box.phar "https://github.com/box-project/box/releases/download/4.6.10/box.phar"
+	wget -O box.phar "https://github.com/box-project/box/releases/download/4.6.10/box.phar"
 fi
 
 echo "$box_phar_hash" | sha256sum -c
@@ -108,8 +107,8 @@ php box.phar compile
 
 phar_test=$(./dev-bin/phar-test.php)
 if [[ -n $phar_test ]]; then
-    echo "Phar test outputed non-empty string: $phar_test"
-    exit 1
+	echo "Phar test outputed non-empty string: $phar_test"
+	exit 1
 fi
 
 # Download test deps
@@ -118,36 +117,35 @@ php composer.phar update
 ./vendor/bin/phpunit
 
 if [ ! -d .gh-pages ]; then
-    echo "Checking out gh-pages in .gh-pages"
-    git clone -b gh-pages [email protected]:maxmind/GeoIP2-php.git .gh-pages
-    pushd .gh-pages
+	echo "Checking out gh-pages in .gh-pages"
+	git clone -b gh-pages [email protected]:maxmind/GeoIP2-php.git .gh-pages
+	pushd .gh-pages
 else
-    echo "Updating .gh-pages"
-    pushd .gh-pages
-    git pull
+	echo "Updating .gh-pages"
+	pushd .gh-pages
+	git pull
 fi
 
 if [ ! -d .maxminddb ]; then
-    echo "Cloning MaxMind-DB for docs"
-    git clone [email protected]:maxmind/MaxMind-DB-Reader-php.git .maxminddb
+	echo "Cloning MaxMind-DB for docs"
+	git clone [email protected]:maxmind/MaxMind-DB-Reader-php.git .maxminddb
 else
-    echo "Updating MaxMind-DB for docs"
-    pushd .maxminddb
-    git pull
-    popd
+	echo "Updating MaxMind-DB for docs"
+	pushd .maxminddb
+	git pull
+	popd
 fi
 
-
 if [ -n "$(git status --porcelain)" ]; then
-    echo ".gh-pages is not clean" >&2
-    exit 1
+	echo ".gh-pages is not clean" >&2
+	exit 1
 fi
 
 # Using Composer is possible, but they don't recommend it.
 phpdocumentor_phar_hash='aa00973d88b278fe59fd8dce826d8d5419df589cb7563ac379856ec305d6b938  phpDocumentor.phar'
 
 if ! echo "$phpdocumentor_phar_hash" | sha256sum -c; then
-    wget -O phpDocumentor.phar https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.8.1/phpDocumentor.phar
+	wget -O phpDocumentor.phar https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.8.1/phpDocumentor.phar
 fi
 
 echo "$phpdocumentor_phar_hash" | sha256sum -c
@@ -157,12 +155,12 @@ cachedir="/tmp/phpdoc-$$-$RANDOM"
 rm -rf "$cachedir"
 
 php phpDocumentor.phar \
-    --visibility=public \
-    --cache-folder="$cachedir" \
-    --title="GeoIP2 PHP API $tag" \
-    run \
-    -d "$PWD/../src" \
-    -t "doc/$tag"
+	--visibility=public \
+	--cache-folder="$cachedir" \
+	--title="GeoIP2 PHP API $tag" \
+	run \
+	-d "$PWD/../src" \
+	-t "doc/$tag"
 # This used to work but doesn't as of 4.5.1. They say that they are working
 # on fixing it. Neither the config file nor the relative path fix work as
 # suggested either.
@@ -171,7 +169,7 @@ php phpDocumentor.phar \
 rm -rf "$cachedir"
 
 page=index.md
-cat <<EOF > $page
+cat <<EOF >$page
 ---
 layout: default
 title: MaxMind GeoIP2 PHP API
@@ -181,18 +179,18 @@ version: $tag
 
 EOF
 
-cat ../README.md >> $page
+cat ../README.md >>$page
 
 git add doc/
 
 echo "Release notes for $tag:"
 echo "$notes"
 
-read -e -p "Commit changes and push to origin? " should_push
+read -r -e -p "Commit changes and push to origin? " should_push
 
 if [ "$should_push" != "y" ]; then
-    echo "Aborting"
-    exit 1
+	echo "Aborting"
+	exit 1
 fi
 
 git commit -m "Updated for $tag" -a
@@ -205,5 +203,3 @@ git commit -m "Update for $tag" -a
 git push
 
 gh release create --target "$(git branch --show-current)" -t "$version" -n "$notes" "$tag" "$phar"
-
-git push --tags