feat: improve release script

Author: GuillaumeLagrange

CONTRIBUTING.md

@@ -2,11 +2,11 @@
 
 ## Release
 
-To create a release, follow these steps:
-
-1. Update the version in the following locations to the new version:
-    - [`core/CMakeLists.txt`](https://github.com/CodSpeedHQ/codspeed-cpp/blob/main/core/CMakeLists.txt#L3) 
+To create a release, run `scripts/release.sh <new_version>` from the main branch. This script will:
+1. Automatically update the version in all relevant files:
+    - [`core/CMakeLists.txt`](https://github.com/CodSpeedHQ/codspeed-cpp/blob/main/core/CMakeLists.txt#L3)
     - [`core/MODULE.bazel`](https://github.com/CodSpeedHQ/codspeed-cpp/blob/main/core/MODULE.bazel#L3)
-    - [`google_benchmark/MODULE.bazel` module's version](https://github.com/CodSpeedHQ/codspeed-cpp/blob/main/google_benchmark/MODULE.bazel#L3)
-    - [`google_benchmark/MODULE.bazel` core dependency version](https://github.com/CodSpeedHQ/codspeed-cpp/blob/main/google_benchmark/MODULE.bazel#L6)
-2. Once the version changes are merged on main, run `scripts/release.sh <new_version>` to tag and create the release on GitHub.
+    - [`google_benchmark/MODULE.bazel`](https://github.com/CodSpeedHQ/codspeed-cpp/blob/main/google_benchmark/MODULE.bazel)
+2. Create a commit with the version changes
+3. Generate the CHANGELOG
+4. Tag and create the release on GitHub

scripts/release.sh

@@ -1,28 +1,57 @@
 #!/bin/bash
 set -e
 
-# Check is on main
-if [ "$(git rev-parse --abbrev-ref HEAD)" != "main" ]; then
-    echo "Not on main branch"
-    exit 1
-fi
-
 # First and only argument is the version number
+VERSION_NO_V=${1} # The version number without the 'v' prefix
 VERSION=v$1 # The version number, prefixed with 'v'
+
+# Check is on main (unless releasing an alpha version)
+if [[ ! "$VERSION_NO_V" =~ -alpha ]]; then
+    if [ "$(git rev-parse --abbrev-ref HEAD)" != "main" ]; then
+        echo "Not on main branch (only alpha releases can be made from non-main branches)"
+        exit 1
+    fi
+fi
+
+# Check that GITHUB_TOKEN is set
+if [ -z "$GITHUB_TOKEN" ]; then
+    echo "GITHUB_TOKEN is not set. Trying to fetch it from gh"
+    GITHUB_TOKEN=$(gh auth token)
+fi
+
+# List of files and line numbers to update with version numbers
+# Format: "file:line_number"
+VERSION_FILES=(
+    "core/CMakeLists.txt:3"
+    "core/MODULE.bazel:3"
+    "google_benchmark/MODULE.bazel:3"
+    "google_benchmark/MODULE.bazel:6"
+)
+
+# Get current version from core/CMakeLists.txt
+PREVIOUS_VERSION=$(grep "set(CODSPEED_VERSION" core/CMakeLists.txt | grep -oP '\d+\.\d+\.\d+')
+
 # Prompt the release version
+echo "Previous version: ${PREVIOUS_VERSION}"
 echo "Release version: $VERSION"
 read -p "Are you sure you want to release this version? (y/n): " confirm
 if [ "$confirm" != "y" ]; then
     echo "Aborting release"
     exit 1
 fi
 
-# Check that GITHUB_TOKEN is set
-if [ -z "$GITHUB_TOKEN" ]; then
-    echo "GITHUB_TOKEN is not set. Trying to fetch it from gh"
-    GITHUB_TOKEN=$(gh auth token)
+# Update version in all relevant files
+echo "Updating version numbers in source files..."
 
-fi
+for entry in "${VERSION_FILES[@]}"; do
+    IFS=':' read -r file line_num <<< "$entry"
+    sed -i "${line_num}s/${PREVIOUS_VERSION}/${VERSION_NO_V}/" "$file"
+    echo "  Updated $file:$line_num"
+done
+
+# Commit version changes
+FILES_TO_COMMIT=$(printf "%s\n" "${VERSION_FILES[@]%%:*}" | sort -u | xargs)
+git add $FILES_TO_COMMIT
 
 git cliff -o CHANGELOG.md --tag $VERSION --github-token $GITHUB_TOKEN
 git add CHANGELOG.md
@@ -51,7 +80,11 @@ git submodule foreach --recursive "git archive --prefix=${ARCHIVE_NAME}/\$path/
 echo "Tarball created at: $TMPDIR/$TARBALL_NAME"
 
 # Create GitHub release with the tarball
-gh release create $VERSION -t $VERSION --generate-notes -d "$TMPDIR/$TARBALL_NAME"
+if [[ "$VERSION_NO_V" =~ -alpha ]]; then
+    gh release create $VERSION -t $VERSION --generate-notes --latest=false "$TMPDIR/$TARBALL_NAME"
+else
+    gh release create $VERSION -t $VERSION --generate-notes --latest "$TMPDIR/$TARBALL_NAME"
+fi
 
 # Cleanup
 rm -rf "$TMPDIR"