chore: update update_refs.sh script to optionally commit changes

Author: NickLarsenNZ

_scripts/update_refs.sh

@@ -5,7 +5,10 @@ set -euo pipefail
 # repository branch references as well as the stackableRelease versions so that
 # demos are properly versioned.
 
-# TODO (@NickLarsenNZ): Add an option to commit each change
+# Parse args:
+# $1 if `commit` is specified as the first argument, then changes will be staged and committed.
+COMMIT="${1:-false}"
+COMMIT="${COMMIT/commit/true}"
 
 CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
 
@@ -28,34 +31,51 @@ function prepend {
   done
 }
 
+# stage and commit based on a message
+function maybe_commit {
+  [ "$COMMIT" == "true" ] || return 0
+  local MESSAGE="$1"
+  PATCH=$(mktemp)
+  git add -u
+  git diff --staged > "$PATCH"
+  git commit -m "$MESSAGE"
+  echo "committed changes with message: $MESSAGE"
+  echo "patch written to: $PATCH"
+}
+
 if [[ "$CURRENT_BRANCH" == release-* ]]; then
   STACKABLE_RELEASE="${CURRENT_BRANCH#release-}"
-  echo "Updating stackableRelease to $STACKABLE_RELEASE"
+  MESSAGE="Update stackableRelease to $STACKABLE_RELEASE"
+  echo "$MESSAGE"
   # NOTE (@NickLarsenNZ): find is not required for such a trivial case, but it is done for consitency
   find stacks/stacks-v2.yaml \
     -exec grep --color=always -l stackableRelease {} \; \
     -exec sed -i -E "s/(stackableRelease:\s+)(\S+)/\1${STACKABLE_RELEASE}/" {} \; \
   | prepend "\t"
+  maybe_commit "chore(release): $MESSAGE"
 
   # TODO (@NickLarsenNZ): Replace 0.0.0-dev refs with ${STACKABLE_RELEASE}.0
   # handle patches later, and what about release-candidates?
   SEARCH='stackable(0\.0\.0-dev|24\.7\.[0-9]+)' # TODO (@NickLarsenNZ): After https://github.com/stackabletech/stackable-cockpit/issues/310, only search for 0.0.0-dev
   REPLACEMENT="stackable${STACKABLE_RELEASE}.0" # TODO (@NickLarsenNZ): Be a bit smarter about patch releases.
-  echo "Updating image references. Searching for $SEARCH, replacing with $REPLACEMENT"
+  MESSAGE="Update image references with $REPLACEMENT"
+  echo "$MESSAGE"
   find demos stacks -type f \
     -exec grep --color=always -lE "$SEARCH" {} \; \
     -exec sed -i -E "s/${SEARCH}/${REPLACEMENT}/" {} \; \
   | prepend "\t"
+  maybe_commit "chore(release): $MESSAGE"
 
   # Look for remaining references
   echo "Checking files with older stackable release references which will be assumed to be intentional."
   grep --color=always -ronE "stackable24\.3(\.[0-9]+)" | prepend "\t"
+  echo
 else
-  >&2 echo "WARNING: doesn't look like a release branch. Will not update stackableRelease versions in stacks."
+  >&2 echo "WARNING: doesn't look like a release branch. Will not update stackableRelease versions in stacks and image references."
 fi
 
-echo
-echo "Replacing githubusercontent references main->${CURRENT_BRANCH}"
+MESSAGE="Replace githubusercontent references main->${CURRENT_BRANCH}"
+echo "$MESSAGE"
 # Search for githubusercontent urls and replace the branch reference with a placeholder variable
 # This is done just in case the branch has special regex characters (like `/`).
 # shellcheck disable=SC2016 # We intentionally don't want to expand the variable.
@@ -71,3 +91,4 @@ for MODIFIED_FILE in $(git diff --name-only); do
   envsubst '$UPDATE_BRANCH_REF' < "$MODIFIED_FILE" > "$MODIFIED_FILE.replacements"
   mv "$MODIFIED_FILE.replacements" "$MODIFIED_FILE"
 done
+maybe_commit "chore(release): $MESSAGE"