From 9b47d1cdb07b11d9034b530acbd8d6bd63284fef Mon Sep 17 00:00:00 2001
From: Curtis Vogt <curtis.vogt@gmail.com>
Date: Thu, 27 Jun 2024 09:47:19 -0500
Subject: [PATCH] Make release instructions more copy/paste-able

---
 devdocs/making_a_new_release.md | 47 ++++++++++++++++-----------------
 1 file changed, 23 insertions(+), 24 deletions(-)

diff --git a/devdocs/making_a_new_release.md b/devdocs/making_a_new_release.md
index 9e86a57..45c3721 100644
--- a/devdocs/making_a_new_release.md
+++ b/devdocs/making_a_new_release.md
@@ -4,53 +4,52 @@ In this guide, as an example, `v2.2.0` refers to the version number of the new r
 
 ## Part 1: Use the Git CLI to create and push the Git tags
 
-Step 1: Create a new lightweight tag of the form `vMAJOR.MINOR.PATCH`.
+Step 1: Clone the repository:
 
 ```bash
 git clone git@github.com:julia-actions/cache.git
 cd cache
-git fetch --all --tags
+```
 
-git checkout main
+Step 2: Create a new lightweight tag of the form `vMAJOR.MINOR.PATCH`.
 
-git --no-pager log -1
-# Take note of the commit hash here.
+```bash
+# Get the commit SHA of the latest pushed commit on the default branch
+git fetch origin --tags --force
+commit_sha=$(git rev-parse origin/HEAD)
+
+# Validate this commit is the one you intend to release
+git --no-pager log -1 ${commit_sha:?}
 
 # Now, create a new lightweight tag of the form `vMAJOR.MINOR.PATCH`.
-#
-# Replace `commit_hash` with the commit hash that you obtained from the
-# `git log -1` step.
-#
 # Replace `v2.2.0` with the actual version number that you want to use.
-git tag v2.2.0 commit_hash
+tag=v2.2.0
+git tag ${tag:?} ${commit_sha:?}
 ```
 
-Step 2: Once you've created the new release, you need to update the `v2` tag to point to the new release. For example, suppose that the previous release was `v2.1.0`, and suppose that you just created the new release `v2.2.0`. You need to update the `v2` tag so that it points to `v2.2.0`. Here are the commands:
+Step 3: Once you've created the new release, you need to update the major tag to point to the new release. For example, suppose that the previous release was `v2.1.0`, and suppose that you just created the new release `v2.2.0`. You need to update the major tag `v2` so that it points to `v2.2.0`. Here are the commands:
 
 ```bash
-# Create/update the new v2 tag locally, where the new v2 tag will point to the
+# Create/update the new major tag locally, where the new major tag will point to the
 # release that you created in the previous step.
 #
-# Make sure to change `v2.2.0` to the actual value for the tag that you just
-# created in the previous step.
-#
-# The `-f` flag forcibly overwrites the old
-# `v2` tag (if it exists).
-git tag -f v2 v2.2.0
+# The `-f` flag forcibly overwrites the old major tag (if it exists).
+major_tag=$(echo ${tag:?} | grep -o '^v[0-9]*')
+git tag -f ${major_tag:?} ${tag:?}
 ```
 
-Step 3: Now you need to push the tags:
+Step 4: Now you need to push the tags:
 
 ```bash
-# Regular-push the new `v2.2.0` tag:
-git push origin tag v2.2.0
+# Regular-push the new tag:
+git push origin tag ${tag:?}
 
-# Force-push the new v2 tag:
-git push origin tag v2 --force
+# Force-push the new major tag:
+git push origin tag ${major_tag:?} --force
 ```
 
 ## Part 2: Create the GitHub Release
 
 Go to the [Releases](https://github.com/julia-actions/cache/releases) section of this repo and create a new release (using the GitHub web interface).
 
-For the "choose a tag" drop-down field, select the `v2.2.0` tag that you created and pushed in Part 1 of this guide.
+For the "choose a tag" drop-down field, select the new tag (e.g. `v2.2.0`) that you created and pushed in Part 1 of this guide.