chore: update release process (#100)

* fix: create one single commit and point all tags to it

* chore: add EOF

* chore: exit release if there are no changes

* chore: extract module URL to variable

* chore: extract next-tag path calculation to a function

* fix: parse version file correctly

* chore: clean build dir

* feat: enable local release before creating the real one

* chore: wording and comments

Author: mdelapenya

.github/scripts/common.sh

@@ -15,6 +15,7 @@
 #   find_latest_tag  - Find latest tag for a given module
 #   get_modules      - Get list of modules from go.work file
 #   get_script_dir   - Get directory of the calling script
+#   portable_sed     - Portable in-place sed editing
 #
 # Constants:
 #   ROOT_DIR         - Root directory of the repository
@@ -36,6 +37,7 @@ get_script_dir() {
 
 readonly CURRENT_DIR="$(get_script_dir)"
 readonly ROOT_DIR="$(dirname $(dirname "${CURRENT_DIR}"))"
+readonly BUILD_DIR="${ROOT_DIR}/.github/scripts/.build"
 readonly GITHUB_REPO="github.com/docker/go-sdk"
 readonly DRY_RUN="${DRY_RUN:-true}"
 
@@ -50,12 +52,9 @@ function curlGolangProxy() {
   #   github.com/docker/go-sdk/client/v0.0.1.info
   #   github.com/docker/go-sdk/client/v0.1.0.info
   #   github.com/docker/go-sdk/client/v1.0.0.info
-  if [[ "${DRY_RUN}" == "true" ]]; then
-    echo "[DRY RUN] Would execute: curl https://proxy.golang.org/${GITHUB_REPO}/${module}/@v/${module_version}.info"
-    return
-  fi
+  local module_url="https://proxy.golang.org/${GITHUB_REPO}/${module}/@v/${module_version}.info"
 
-  curl "https://proxy.golang.org/${GITHUB_REPO}/${module}/@v/${module_version}.info"
+  execute_or_echo curl "${module_url}"
 }
 
 
@@ -79,16 +78,18 @@ find_latest_tag() {
   git tag --list | grep -E "${module}/v[0-9]+\.[0-9]+\.[0-9]+.*" | sort -V | tail -n 1
 }
 
+# Function to get the next tag for a module
+get_next_tag() {
+  local module="$1"
+  local next_tag_path="${BUILD_DIR}/${module}-next-tag"
+  echo "${next_tag_path}"
+}
+
 # Portable in-place sed editing that works on both BSD (macOS) and GNU (Linux) sed
 portable_sed() {
   local pattern="$1"
   local file="$2"
 
-  if [[ "$DRY_RUN" == "true" ]]; then
-    echo "[DRY RUN] Would execute: sed '$pattern' in $file"
-    return
-  fi
-  
   # Detect sed version and use appropriate syntax
   if sed --version >/dev/null 2>&1; then
     # GNU sed (Linux)
@@ -97,4 +98,4 @@ portable_sed() {
     # BSD sed (macOS)
     sed -i '' "$pattern" "$file"
   fi
-}
+}

.github/scripts/pre-release.sh

@@ -110,7 +110,13 @@ MODULE=$(echo "$MODULE" | tr '[:upper:]' '[:lower:]')
 if [[ "$DRY_RUN" == "true" ]]; then
   echo "[DRY RUN] Would update ${ROOT_DIR}/${MODULE}/version.go with version: ${NEXT_VERSION}"
 else
-  portable_sed "s/version = \"[^\"]*\"/version = \"${NEXT_VERSION}\"/" "${ROOT_DIR}/${MODULE}/version.go"
+  # Regex explanation:
+  #   ^([[:space:]]*version[[:space:]]*=[[:space:]]*)\"[^\"]*\"
+  #   - ^ : Start of line
+  #   - ([[:space:]]*version[[:space:]]*=[[:space:]]*) : Group 1 matches any leading whitespace, the word 'version', optional whitespace, '=', optional whitespace
+  #   - \"[^\"]*\" : Matches a quoted string (the version value)
+  # The replacement keeps the left part and replaces the quoted value with the new version.
+  portable_sed "s/^\([[:space:]]*version[[:space:]]*=[[:space:]]*\)\"[^\"]*\"/\1\"${NEXT_VERSION}\"/" "${ROOT_DIR}/${MODULE}/version.go"
 fi
 
 # if next version does not start with v, add it
@@ -133,14 +139,10 @@ echo "Next tag: ${NEXT_TAG}"
 MODULES=$(go work edit -json | jq -r '.Use[] | "\(.DiskPath | ltrimstr("./"))"' | tr '\n' ' ' && echo)
 
 # Save the next tag for the module to a file so that the release script can use it
-execute_or_echo echo "${NEXT_vVERSION}" > "${ROOT_DIR}/.github/scripts/.${MODULE}-next-tag"
+echo "${NEXT_vVERSION}" > "$(get_next_tag "${MODULE}")"
 
 for m in $MODULES; do
-  if [[ "$DRY_RUN" == "true" ]]; then
-    echo "[DRY RUN] Would update ${ROOT_DIR}/${m}/go.mod: ${GITHUB_REPO}/${MODULE} v${NEXT_VERSION}"
-  else
-    portable_sed "s|${GITHUB_REPO}/${MODULE} v[^[:space:]]*|${GITHUB_REPO}/${MODULE} v${NEXT_VERSION}|g" "${ROOT_DIR}/${m}/go.mod"
-    # Update the go.sum file
-    (cd "${ROOT_DIR}/${m}" && execute_or_echo go mod tidy)
-  fi
+  portable_sed "s|${GITHUB_REPO}/${MODULE} v[^[:space:]]*|${GITHUB_REPO}/${MODULE} v${NEXT_VERSION}|g" "${ROOT_DIR}/${m}/go.mod"
+  # Update the go.sum file
+  (cd "${ROOT_DIR}/${m}" && go mod tidy)
 done

.github/scripts/release.sh

@@ -12,7 +12,8 @@
 #
 # Environment Variables:
 #   DRY_RUN          - Enable dry run mode (default: true)
-#                      When true, shows git commands without executing them
+#                      When true, shows commands without executing them, except for git commands
+#                      that are executed but before pushing the changes to the remote repository.
 #
 # Examples:
 #   ./.github/scripts/release.sh
@@ -41,28 +42,65 @@ set -e
 readonly SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 source "${SCRIPT_DIR}/common.sh"
 
+# Collect and stage changes across modules, then create a single commit
 MODULES=$(go work edit -json | jq -r '.Use[] | "\(.DiskPath | ltrimstr("./"))"' | tr '\n' ' ' && echo)
+
+commit_title="chore(release): bump module versions"
+commit_body=""
+
 for m in $MODULES; do
+  next_tag_path=$(get_next_tag "${m}")
   # if the module version file does not exist, skip it
-  if [[ ! -f "${ROOT_DIR}/.github/scripts/.${m}-next-tag" ]]; then
+  if [[ ! -f "${next_tag_path}" ]]; then
     echo "Skipping ${m} because the pre-release script did not run"
     continue
   fi
 
-  execute_or_echo git add "${ROOT_DIR}/${m}/version.go"
-  execute_or_echo git add "${ROOT_DIR}/${m}/go.mod"
+  git add "${ROOT_DIR}/${m}/version.go"
+  git add "${ROOT_DIR}/${m}/go.mod"
+  if [[ -f "${ROOT_DIR}/${m}/go.sum" ]]; then
+    git add "${ROOT_DIR}/${m}/go.sum"
+  fi
 
-  nextTag=$(cat "${ROOT_DIR}/.github/scripts/.${m}-next-tag")
+  nextTag=$(cat "${next_tag_path}")
   echo "Next tag for ${m}: ${nextTag}"
-  execute_or_echo git commit -m "chore(${m}): bump version to ${nextTag}"
+  commit_body="${commit_body}\n - ${m}: ${nextTag}"
+done
+
+# Create a single commit if there are staged changes
+if [[ -n "$(git diff --cached)" ]]; then
+  git commit -m "${commit_title}" -m "$(echo -e "${commit_body}")"
+else
+  echo "No changes detected in modules. Release process aborted."
+  exit 1 # exit with error code 1 to not proceed with the release
+fi
 
-  execute_or_echo git tag "${m}/${nextTag}"
+# Create all tags after the single commit
+for m in $MODULES; do
+  next_tag_path=$(get_next_tag "${m}")
+  if [[ -f "${next_tag_path}" ]]; then
+    nextTag=$(cat "${next_tag_path}")
+    git tag "${m}/${nextTag}"
+  fi
 done
 
+if [[ "${DRY_RUN}" == "true" ]]; then
+  echo "Remote operations will be skipped."
+  # show the last commit, including the patch
+  echo "Last commit:"
+  git_log_format='%C(auto)%h%C(reset) %s%nAuthor: %an <%ae>%nDate:   %ad'
+  git -C "${ROOT_DIR}" --no-pager log -1 --pretty=format:"${git_log_format}" --date=iso-local
+  git -C "${ROOT_DIR}" --no-pager show -1 --format= --patch --stat
+  # list the new tags, that should point to the same last commit
+  echo "New tags:"
+  git -C "${ROOT_DIR}" --no-pager tag --list --points-at HEAD
+fi
+
+echo "Pushing changes and tags to remote repository..."
+
 execute_or_echo git push origin main --tags
 
 for m in $MODULES; do
-  nextTag=$(cat "${ROOT_DIR}/.github/scripts/.${m}-next-tag")
+  nextTag=$(cat $(get_next_tag "${m}"))
   curlGolangProxy "${m}" "${nextTag}"
-  execute_or_echo rm "${ROOT_DIR}/.github/scripts/.${m}-next-tag"
 done

.github/workflows/release-modules.yml

@@ -66,6 +66,7 @@ jobs:
       env:
         DRY_RUN: ${{ inputs.dry_run }}
         BUMP_TYPE: ${{ inputs.bump_type }}
+        LOCAL_RELEASE: false
       run: |
         echo "Starting release process..."
         make release-all

.gitignore

@@ -1,4 +1,4 @@
-.github/scripts/.*-next-tag
+.github/scripts/.build
 coverage.out
 output.txt
 TEST-unit.xml

Makefile

@@ -15,8 +15,13 @@ tidy-all:
 	@echo "Running tidy in all modules..."
 	$(call for-all-modules,go mod tidy)
 
+clean-build-dir:
+	@echo "Cleaning build directory..."
+	@rm -rf .github/scripts/.build
+	@mkdir -p .github/scripts/.build
+
 # Release version for all modules
-release-all:
+release-all: clean-build-dir
 	@echo "Preparing releasing versions for all modules..."
 	$(call for-all-modules,make pre-release)
 

RELEASING.md

@@ -67,7 +67,7 @@ DRY_RUN=false make release-all
 ```
 
 #### Environment Variables
-- `DRY_RUN`: `true` (default) or `false`
+- `DRY_RUN`: `true` (default) or `false`. It generates the release (commit and tags) locally, without pushing changes to the remote repository.
 - `BUMP_TYPE`: `prerelease` (default), `patch`, `minor`, or `major`. To know more about the bump type values, please read more [here](https://github.com/fsaintjacques/semver-tool).
 
 ## Release Types
@@ -102,6 +102,7 @@ DRY_RUN=false make release-all
 
 ### 2. File Updates
 For each module:
+- Writes the next version to a file in the build directory, located at `.github/scripts/.build/<module>-next-tag`. This is a temporary file that is used to store the next version for the module.
 - Updates `<module>/version.go` with new version
 - Updates all `go.mod` files with new cross-module dependencies
 - Runs `go mod tidy` to update `go.sum` files
@@ -111,10 +112,14 @@ For each module:
 - Creates git tags for each module (e.g., `client/v0.1.0-alpha006`)
 - Pushes changes and tags to GitHub
 
+If `DRY_RUN` is `true`, the script does not push changes and tags to the remote repository.
+
 ### 4. Go Proxy Registration
 - Triggers Go proxy to fetch new module versions
 - Makes modules immediately available for download
 
+If `DRY_RUN` is `true`, the script does not trigger the Go proxy.
+
 ## Troubleshooting
 
 ### Common Issues

commons-test.mk

@@ -84,4 +84,4 @@ pre-release:
 		exit 1; \
 	fi
 	@echo "Releasing version for module: $(MODULE_DIR)"
-	@$(ROOT_DIR)/.github/scripts/pre-release.sh "$(MODULE_DIR)"
+	@$(ROOT_DIR)/.github/scripts/pre-release.sh "$(MODULE_DIR)"