feat: replace git-release with makerelease.sh

Add a new release helper that supports clean-tree checks, dry-run mode, and semantic version increments from the latest tag. Remove the old git-release script and update project conventions to reflect the new release workflow.
2026-04-27 22:13:24 +02:00
parent 8a0ddde506
commit 82aeed5882
3 changed files with 143 additions and 35 deletions
@@ -7,14 +7,19 @@ description: SSHRM project conventions
 - Keep shell scripts Bash-based when Bash is already used by the project.
 - Preserve the current behavior of the main scripts:
  - `sshrm`: remove an entry from `~/.ssh/known_hosts` by host name or by line number.
-  - `git-release`: handle releases from `dev` to `main`, create an annotated tag, and push commits and tags.
 - Keep user-facing messages short, clear, and in English.
- Prefer minimal, focused changes that do not alter the intent of the existing scripts.
+- Prefer minimal, focused changes that do not alter the intent of the existing scripts, unless the script behavior is intentionally updated.
 - Maintain `.continue/rules/project.md` whenever project conventions or script behavior change.
 - `sshrm` is implemented as a small Bash script with helper functions, while preserving host and line-number removal behavior.
 - `sshrm` should print a short usage line, support `-h`/`--help`, and fail clearly on missing or invalid line-number input.

 # Project identity
 - Main script: `sshrm`
- Release helper: `git-release`
 - License: GNU GPL v3
+
+git checkout "${TAGBRANCH}"
+git merge "${CURRENTBRANCH}"
+git push
+git tag -a "${VERSION}" -m "${MESSAGE}"
+git push --tags
+git checkout "${CURRENTBRANCH}"
@@ -1,32 +0,0 @@
-#!/bin/bash
-
-declare -r VERSION=${1}
-declare -r MESSAGE=${2}
-declare -r TAGBRANCH=main
-declare CURRENTBRANCH=""
-
-showHelp() {
-	echo git-release version
-}
-
-if [ "${VERSION}" == "" ]; then
-	showHelp
-	echo ""
-	echo "no version provided!"
-	exit 1
-fi
-
-CURRENTBRANCH=$(git rev-parse --abbrev-ref HEAD)
-
-if [ ! "${CURRENTBRANCH}" == "dev" ]; then
-	echo "You are not in dev branch!"
-	echo "Use dev branch to make a release!"
-	exit 1
-fi
-
-git checkout "${TAGBRANCH}"
-git merge "${CURRENTBRANCH}"
-git push
-git tag -a "${VERSION}" -m "${MESSAGE}"
-git push --tags
-git checkout "${CURRENTBRANCH}"
@@ -0,0 +1,135 @@
+#!/bin/bash
+
+set -euo pipefail
+
+declare -r TAGBRANCH=main
+declare CURRENTBRANCH=""
+declare ORIGBRANCH=""
+declare -r ARG1="${1:-}"
+declare -r ARG2="${2:-}"
+declare is_dry_run=false
+declare release_input=""
+
+showHelp() {
+	cat <<'EOF'
+Usage:
+  makerelease.sh VERSION
+  makerelease.sh +0.0.1
+  makerelease.sh +0.1
+  makerelease.sh +1
+  makerelease.sh --dry-run VERSION
+  makerelease.sh --dry-run +0.0.1
+  makerelease.sh --dry-run +0.1
+  makerelease.sh --dry-run +1
+
+Creates an annotated Git tag from the current dev branch.
+
+If VERSION starts with +, it is treated as an increment:
+- +0.0.1 increments patch
+- +0.1 increments minor
+- +1 increments major
+
+Use --dry-run to show the computed release version without running Git actions.
+
+Requirements:
+- run from a clean Git working tree
+- current branch must be dev for real releases
+- main branch must exist locally
+EOF
+}
+
+cleanup() {
+	if [ -n "${ORIGBRANCH}" ] && [ "${CURRENTBRANCH}" != "${ORIGBRANCH}" ]; then
+		git checkout "${ORIGBRANCH}" >/dev/null 2>&1 || true
+	fi
+}
+
+trap cleanup EXIT
+
+if [ "${ARG1}" = "--dry-run" ] || [ "${ARG1}" = "-n" ]; then
+	is_dry_run=true
+	release_input="${ARG2:-}"
+else
+	release_input="${ARG1}"
+fi
+
+if [ -z "${release_input}" ]; then
+	showHelp
+	echo ""
+	echo "no version provided!"
+	exit 1
+fi
+
+if ! git rev-parse --is-inside-work-tree >/dev/null 2>&1; then
+	echo "You are not inside a Git repository!"
+	exit 1
+fi
+
+if [ -n "$(git status --porcelain)" ]; then
+	echo "Working tree is not clean!"
+	echo "Commit or stash your changes before creating a release."
+	exit 1
+fi
+
+CURRENTBRANCH=$(git rev-parse --abbrev-ref HEAD)
+ORIGBRANCH="${CURRENTBRANCH}"
+
+if [ "${is_dry_run}" = false ] && [ "${CURRENTBRANCH}" != "dev" ]; then
+	echo "You are not in dev branch!"
+	echo "Use dev branch to make a release!"
+	exit 1
+fi
+
+release_tag="${release_input}"
+if [ "${release_input}" != "${release_input#+}" ]; then
+	current_tag="$(git describe --tags --abbrev=0 2>/dev/null || true)"
+	if [ -z "${current_tag}" ]; then
+		echo "No existing tag found to increment from!"
+		exit 1
+	fi
+	case "${release_input}" in
+		+1)
+			release_tag="$(printf '%s' "${current_tag}" | awk -F. 'BEGIN{OFS="."} { $1+=1; $2=0; $3=0; print }')"
+			;;
+			+0.1)
+			release_tag="$(printf '%s' "${current_tag}" | awk -F. 'BEGIN{OFS="."} { $2+=1; $3=0; print }')"
+			;;
+			+0.0.1)
+			release_tag="$(printf '%s' "${current_tag}" | awk -F. 'BEGIN{OFS="."} { $3+=1; print }')"
+			;;
+		*)
+			echo "Unsupported increment syntax: ${release_input}"
+			exit 1
+			;;
+	esac
+fi
+
+if git rev-parse -q --verify "refs/tags/${release_tag}" >/dev/null; then
+	echo "Tag ${release_tag} already exists!"
+	exit 1
+fi
+
+if [ "${is_dry_run}" = true ]; then
+	echo "Dry run: computed release tag ${release_tag}"
+	exit 0
+fi
+
+echo "Release tag selected: ${release_tag}"
+read -r -p "Proceed with release? [y/N] " confirm
+case "${confirm}" in
+	y|Y)
+		;;
+	*)
+		echo "Release cancelled."
+		exit 1
+		;;
+esac
+
+git checkout "${TAGBRANCH}"
+CURRENTBRANCH="${TAGBRANCH}"
+git merge "${ORIGBRANCH}"
+git push
+git tag -a "${release_tag}" -m "Release ${release_tag}"
+git push --tags
+
+echo "Created release tag ${release_tag}"