feat: add dry-run mode to release script

adriencaccia · claude · adriencaccia · commit 6e1e277acad8 · 2026-04-08T11:57:52.000+02:00
The release script now defaults to dry-run mode, showing a summary of
all actions and release notes without making any changes. Pass --execute
to actually perform the release.

Co-Authored-By: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;
diff --git a/scripts/release.sh b/scripts/release.sh
@@ -1,13 +1,30 @@
 #!/bin/bash
-# Usage: ./scripts/release.sh
-set -ex
+# Usage: ./scripts/release.sh [--execute]
+# By default, runs in dry-run mode. Pass --execute to actually perform the release.
+set -e
 
-# Prechecks
+EXECUTE=false
+for arg in "$@"; do
+  case "$arg" in
+    --execute) EXECUTE=true ;;
+    *) echo "Unknown argument: $arg"; exit 1 ;;
+  esac
+done
+
+if [ "$EXECUTE" = false ]; then
+  echo "=== DRY RUN MODE (pass --execute to perform the release) ==="
+fi
+
+# Pre-checks
 if [ "$(git rev-parse --abbrev-ref HEAD)" != "main" ]; then
   echo "You must be on the main branch to release"
   exit 1
 fi
-git diff --exit-code
+if ! git diff --quiet; then
+  echo "Error: Working tree is not clean. The following files have uncommitted changes:"
+  git diff --name-only | sed 's/^/  /'
+  exit 1
+fi
 
 # Bump version
 NEW_VERSION=$(cat .codspeed-runner-version)
@@ -16,27 +33,52 @@ if ! [[ "$NEW_VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
   echo "Version must be a valid semver (e.g. 1.2.3)"
   exit 1
 fi
-MAJOR_VERSION=$(echo $NEW_VERSION | cut -d. -f1)
+MAJOR_VERSION=$(echo "$NEW_VERSION" | cut -d. -f1)
+
+# Determine release notes strategy
+RUNNER_NOTES=$(gh release view "v$NEW_VERSION" -R CodSpeedHQ/codspeed --json body | jq -r .body)
+RELEASE_NOTES="$RUNNER_NOTES
+
+
+**Full Runner Changelog**: https://github.com/CodSpeedHQ/codspeed/blob/main/CHANGELOG.md"
+
+# Summary
+echo ""
+echo "Version: v$NEW_VERSION"
+echo "Major tag: v$MAJOR_VERSION"
+echo ""
+echo "The following actions will be performed:"
+echo "  - Create an empty commit: \"Release v$NEW_VERSION 🚀\""
+echo "  - Create/update tag v$NEW_VERSION"
+echo "  - Force-update tag v$MAJOR_VERSION"
+echo "  - Push tags and commits"
+echo "  - Create a draft GitHub release v$NEW_VERSION with runner release notes"
+
+if [ "$EXECUTE" = false ]; then
+  echo ""
+  echo "Release notes:"
+  echo "---"
+  echo "$RELEASE_NOTES"
+  echo "---"
+  echo ""
+  echo "=== DRY RUN: No changes were made ==="
+  exit 0
+fi
+
+set -x
 
 # Ask for confirmation
-read -p "Are you sure you want to release v$NEW_VERSION? Bumping the v$MAJOR_VERSION major version ?(y/n) " -n 1 -r
+read -p "Are you sure you want to release v$NEW_VERSION? Bumping the v$MAJOR_VERSION major version? (y/n) " -n 1 -r
 echo
 if [[ ! $REPLY =~ ^[Yy]$ ]]; then
   exit 1
 fi
 
-# Fail if there are any unstaged changes left
-git diff --exit-code
 git commit -m "Release v$NEW_VERSION 🚀" --allow-empty
-git tag -s -fa v$NEW_VERSION -m "Release v$NEW_VERSION 🚀"
-git tag -s -fa v$MAJOR_VERSION -m "Release v$NEW_VERSION 🚀"
-git push origin tag v$NEW_VERSION
-git push -f origin tag v$MAJOR_VERSION
+git tag -s -fa "v$NEW_VERSION" -m "Release v$NEW_VERSION 🚀"
+git tag -s -fa "v$MAJOR_VERSION" -m "Release v$NEW_VERSION 🚀"
+git push origin tag "v$NEW_VERSION"
+git push -f origin tag "v$MAJOR_VERSION"
 git push --follow-tags
 
-RUNNER_NOTES=$(gh release view v$NEW_VERSION -R CodSpeedHQ/codspeed --json body | jq -r .body)
-RUNNER_NOTES="$RUNNER_NOTES
-
-
-**Full Runner Changelog**: https://github.com/CodSpeedHQ/codspeed/blob/main/CHANGELOG.md"
-gh release create v$NEW_VERSION --title "v$NEW_VERSION" --notes "$RUNNER_NOTES" -d
+gh release create "v$NEW_VERSION" --title "v$NEW_VERSION" --notes "$RELEASE_NOTES" -d
