Add -h, --help to release.sh

mafredri · mafredri · commit 132c70e59dcb · 2023-01-10T16:01:11.000Z
diff --git a/scripts/release.sh b/scripts/release.sh
@@ -1,45 +1,49 @@
 #!/usr/bin/env bash
 
-# This script should be called to create a new release.
-#
-# When run, this script will display the new version number and optionally a
-# preview of the release notes. The new version will be selected automatically
-# based on if the release contains breaking changes or not. If the release
-# contains breaking changes, a new minor version will be created. Otherwise, a
-# new patch version will be created.
-#
-# Set --ref if you need to specify a specific commit that the new version will
-# be tagged at, otherwise the latest commit will be used.
-#
-# Set --minor to force a minor version bump, even when there are no breaking
-# changes. Likewise for --major. By default a patch version will be created.
-#
-# Set --dry-run to run the release workflow in CI as a dry-run (no release will
-# be created).
-#
-# To mark a release as containing breaking changes, the commit title should
-# either contain a known prefix with an exclamation mark ("feat!:",
-# "feat(api)!:") or the PR that was merged can be tagged with the
-# "release/breaking" label.
-#
-# To test changes to this script, you can set `--branch <my-branch>`, which will
-# run the release workflow in CI as a dry-run and use the latest commit on the
-# specified branch as the release commit. This will also set --dry-run.
-#
-# Usage: ./release.sh [--branch <name>] [--draft] [--dry-run] [--ref <ref>] [--major | --minor | --patch]
-
 set -euo pipefail
 # shellcheck source=scripts/lib.sh
 source "$(dirname "${BASH_SOURCE[0]}")/lib.sh"
 cdroot
 
+help() {
+	cat <<-EOH
+		Usage: ./release.sh [--branch <name>] [--draft] [--dry-run] [--ref <ref>] [--major | --minor | --patch]
+
+		This script should be called to create a new release.
+
+		When run, this script will display the new version number and optionally a
+		preview of the release notes. The new version will be selected automatically
+		based on if the release contains breaking changes or not. If the release
+		contains breaking changes, a new minor version will be created. Otherwise, a
+		new patch version will be created.
+
+		Set --ref if you need to specify a specific commit that the new version will
+		be tagged at, otherwise the latest commit will be used.
+
+		Set --minor to force a minor version bump, even when there are no breaking
+		changes. Likewise for --major. By default a patch version will be created.
+
+		Set --dry-run to run the release workflow in CI as a dry-run (no release will
+		be created).
+
+		To mark a release as containing breaking changes, the commit title should
+		either contain a known prefix with an exclamation mark ("feat!:",
+		"feat(api)!:") or the PR that was merged can be tagged with the
+		"release/breaking" label.
+
+		To test changes to this script, you can set --branch <my-branch>, which will
+		run the release workflow in CI as a dry-run and use the latest commit on the
+		specified branch as the release commit. This will also set --dry-run.
+	EOH
+}
+
 branch=main
 draft=0
 dry_run=0
 ref=
 increment=
 
-args="$(getopt -o n -l branch:,draft,dry-run,ref:,major,minor,patch -- "$@")"
+args="$(getopt -o h -l branch:,draft,dry-run,help,ref:,major,minor,patch -- "$@")"
 eval set -- "$args"
 while true; do
 	case "$1" in
@@ -58,6 +62,10 @@ while true; do
 		dry_run=1
 		shift
 		;;
+	-h | --help)
+		help
+		exit 0
+		;;
 	--ref)
 		ref="$2"
 		shift 2
diff --git a/scripts/release/increment_version_tag.sh b/scripts/release/increment_version_tag.sh
@@ -19,7 +19,7 @@ dry_run=0
 ref=HEAD
 increment=
 
-args="$(getopt -o n -l dry-run,ref:,major,minor,patch -- "$@")"
+args="$(getopt -o '' -l dry-run,ref:,major,minor,patch -- "$@")"
 eval set -- "$args"
 while true; do
 	case "$1" in
