Add release_revert script

Author: surpher

Support/Scripts/CI/version_numbers Support/Scripts/CI/version_numbers.shSupport/Scripts/CI/version_numbers renamed to Support/Scripts/CI/version_numbers.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+# shellcheck disable=SC2034
+
+# Xcode version to use
+# Only care about major and minor
+MIN_XCODE_VERSION="16.1"
+XCODE_VERSION_MIN_SUGGESTED="16.1"
+XCODE_VERSION_MIN_SUPPORTED="16.0"
+
+# Project configuration
+CONFIGURATION_FILE="Configurations/Project-Shared.xcconfig"
+CHANGE_LOG="CHANGELOG.md"
+TAG_MESSAGE_FILE="TAG_MESSAGE_FILE.md"
+XCFRAMEWORK_NAME="PactSwiftMockServer.xcframework"
+
+REMOTE_NAME="PactSwiftServer"
+RELEASE_REPO_NAME="PactSwiftServer"
+DEFAULT_REPO_NAME="PactSwiftMockServer"
+REPO_OWNER="surpher"
+REMOTE_REPO_BASE="[email protected]:$REPO_OWNER"

Support/Scripts/Config/config.sh

@@ -67,41 +67,25 @@ fi
 
 # "import"
 source "$RELEASE_SOURCE_DIR/utils.sh"
-source "$RELEASE_SOURCE_DIR/CI/version_numbers"
+source "$RELEASE_SOURCE_DIR/CI/version_numbers.sh"
+source "$RELEASE_SOURCE_DIR/Config/config.sh"
 
 SHOULD_BUILD_RUST_BIN=${SHOULD_BUILD_RUST_BIN:-true}
 
-CONFIGURATION_FILE="Configurations/Project-Shared.xcconfig"
-RELEASE_NOTES="CHANGELOG.md"
-TAG_MESSAGE_FILE="TAG_MESSAGE_FILE.md"
-XCFRAMEWORK_NAME="PactSwiftMockServer.xcframework"
+DRY_RUN=false
 
 CURRENT_BRANCH=$(git branch --show-current)
 RELEASE_VERSION_PART=""
 RELEASE_DESCRIPTION=""
-DRY_RUN=false
-
-REMOTE_NAME="releases"
-RELEASE_REPO_NAME="PactSwiftServer"
-DEFAULT_REPO_NAME="PactSwiftMockServer"
-REPO_OWNER="surpher"
-REMOTE_REPO_BASE="[email protected]:$REPO_OWNER"
-
 LATEST_TAG=$(latest_tag)
 
 ####################
 # Utilities
 ####################
 
-function die {
-  echo "🚨 [ERROR] $*"
-  echo
-  exit 1
-}
-
 function git_clean_orphan {
   echo -e "🛀 Cleaning up the branch..."
-  EXCEPT_FILES="${RELEASE_NOTES} ${XCFRAMEWORK_NAME}"
+  EXCEPT_FILES="${CHANGE_LOG} ${XCFRAMEWORK_NAME}"
   EXCEPT_FILES="${EXCEPT_FILES// /|}"
   git ls-files | grep -v -E "$EXCEPT_FILES" | xargs git rm -f
 }
@@ -163,7 +147,8 @@ function github_open_draft_pull_request {
     fi
   else
     echo "🤷 'gh' not installed."
-    echo "Open https://github.com/$REPO_OWNER/$RELEASE_REPO_NAME/pulls and open one manually..."
+    echo "  Open https://github.com/$REPO_OWNER/$RELEASE_REPO_NAME/pulls and open one manually..."
+    echo "  See https://cli.github.com/ for more information..."
   fi
 }
 
@@ -177,8 +162,10 @@ function git_create_and_push_new_version {
   local REMOTE_BRANCH="$2"
   local RELEASE_NAME="$3"
 
+  generate_changelog
+
   local GIT_COMMANDS=(
-    "git add ${RELEASE_NOTES} ${XCFRAMEWORK_NAME}"
+    "git add ${CHANGE_LOG} ${XCFRAMEWORK_NAME}"
     "git commit -S -m \"$RELEASE_NAME\""
     "git stash -u"
     "git merge $REMOTE_NAME/main --allow-unrelated-histories -X theirs -S --no-edit"
@@ -204,16 +191,20 @@ function git_create_and_push_new_version {
 
 function cleanup {
   local git_clean="git clean -f -d -x"
+
   echo "🧹 Cleanning up..."
   echo "$git_clean"
   eval "$git_clean"
 
   echo "⏮️ Checking out $CURRENT_BRANCH..."
-  git checkout "$CURRENT_BRANCH"
+  git checkout --force "$CURRENT_BRANCH"
+
+  echo "🧹 Removing $YELLOW$VERSION_BRANCH$NOCOLOR"
+  git branch -D "$VERSION_BRANCH"
 }
 
 function generate_changelog {
-  echo "📝 Generating release notes in $RELEASE_NOTES..."
+  echo "📝 Generating release notes in $CHANGE_LOG..."
 
   # Prepare the title for this release
   echo "## ${VERSION_TAG}" > "${TAG_MESSAGE_FILE}"
@@ -223,28 +214,30 @@ function generate_changelog {
   echo -e "🪵 Logging '${LATEST_TAG}..HEAD'..."
   git log --pretty='* %h - %s (%an)' "${LATEST_TAG}"..HEAD >> "${TAG_MESSAGE_FILE}"
 
-  RELEASE_NOTES_TITLE=$(head -n 1 "$RELEASE_NOTES")
-  RELEASE_NOTES_EXISTING=$(tail -n +2 "$RELEASE_NOTES")
+  local RELEASE_NOTES_TITLE=
+  RELEASE_NOTES_TITLE=$(head -n 1 "$CHANGE_LOG")
+  local RELEASE_NOTES_EXISTING=
+  RELEASE_NOTES_EXISTING=$(tail -n +2 "$CHANGE_LOG")
 
   # Inject the new commits between title and last release
   {
     echo "$RELEASE_NOTES_TITLE"
     echo
     cat "${TAG_MESSAGE_FILE}"
     echo "$RELEASE_NOTES_EXISTING"
-  } > "$RELEASE_NOTES"
+  } > "$CHANGE_LOG"
 }
 
 function git_commit_changelog_and_xcconfig {
   local marketing_version="${MARKETING_VERSION:-1}"
-  echo "🩹 Committing $RELEASE_NOTES to git..."
-  git add "${RELEASE_NOTES}" "${CONFIGURATION_FILE}"
+  echo "🩹 Committing $CHANGE_LOG to git..."
+  git add "${CHANGE_LOG}" "${CONFIGURATION_FILE}"
   git commit -m "$marketing_version: Release notes"
 }
 
 function git_reset_changelog {
-  echo "🔙 Resetting last commit"
-  git reset --soft HEAD~1
+  echo "🔙 Dropping last commit..."
+  git reset --hard HEAD~1
   git status
 }
 
@@ -256,24 +249,30 @@ function git_push_changelog {
 ##################
 # Pre-checks
 ##################
-while getopts ":v:d:-:" opt; do
+while getopts ":v:d:h:-:" opt; do
   case ${opt} in
     v)
       RELEASE_VERSION_PART=$OPTARG
       ;;
     d)
       RELEASE_DESCRIPTION=$OPTARG
       ;;
+    h)
+      show_help
+      ;;
     -)
       case "${OPTARG}" in
         dry-run)
           DRY_RUN=true
-          shift 2
+          shift
           ;;
         description)
           RELEASE_DESCRIPTION=$1
           shift 2
           ;;
+        help)
+          show_help
+          ;;
         *)
           echo "Invalid option: --${OPTARG}" >&2
           show_help
@@ -312,7 +311,7 @@ git_add_remote "$REMOTE_NAME" "$REMOTE_REPO_BASE/$RELEASE_REPO_NAME.git"
 echo "📝 Generate changelog"
 generate_changelog
 
-# Bump up the MARKETING_VERSION in xcconfig
+# Bump up the MARKETING_VERSION in xcconfig so XCFramework uses the right version
 echo -e "👊 Bumping up MARKETING_VERSION in xcconfig to $MARKETING_VERSION..."
 update_version_file "$MARKETING_VERSION"
 
@@ -345,7 +344,7 @@ github_open_draft_pull_request "$MARKETING_VERSION" "$VERSION_BRANCH"
 # Cleanup
 ##################
 if [ "$DRY_RUN" = true ]; then
-  cmd="git checkout --force $CURRENT_BRANCH"
+  cmd="git clean -f -d -x && git checkout --force $CURRENT_BRANCH"
   echo "🍸 Dry run done"
   read -r -p "Clean up what has been generated during dry run? [Y/n]" -n 1 USER_INPUT
   echo