docs: document release confirmation step

This commit is contained in:
2026-04-27 20:40:46 +02:00
parent 09f81b8e7c
commit 776ab48458
3 changed files with 25 additions and 8 deletions
+5 -2
View File
@@ -40,6 +40,8 @@ Current behavior:
- checks that the current branch is `dev` - checks that the current branch is `dev`
- verifies the working tree is clean - verifies the working tree is clean
- checks that the target tag does not already exist - checks that the target tag does not already exist
- displays the computed release tag before proceeding
- asks for confirmation before any Git action
- checks out `main` - checks out `main`
- merges `dev` into `main` - merges `dev` into `main`
- pushes the branch - pushes the branch
@@ -49,9 +51,10 @@ Current behavior:
Notes: Notes:
- the script uses `set -euo pipefail` - the script uses `set -euo pipefail`
- the release tag message is now generated automatically as `Release <version>` - the release tag message is automatically generated as `Release <version>`
- the script no longer requires a separate release message argument - the script no longer requires a separate release message argument
- the current increment logic assumes simple dotted numeric tags - the current increment logic assumes simple dotted numeric tags
- normal releases now require an interactive confirmation after the tag is displayed
Recommendations: Recommendations:
- consider validating the version format more strictly if release rules grow - consider validating the version format more strictly if release rules grow
@@ -60,7 +63,7 @@ Recommendations:
### 3) `README.md` ### 3) `README.md`
Current status: Current status:
- the README documents both scripts in English - the README documents both scripts in English
- it now includes release increments and dry-run usage for `makerelease.sh` - it includes release increments, dry-run usage, and the confirmation step for `makerelease.sh`
Recommendations: Recommendations:
- keep it aligned with the actual script behavior - keep it aligned with the actual script behavior
+9 -6
View File
@@ -47,12 +47,14 @@ sudo ./fullupgrade
1. checks that the current branch is `dev` for real releases 1. checks that the current branch is `dev` for real releases
2. verifies the working tree is clean 2. verifies the working tree is clean
3. optionally computes a new version from an increment shortcut 3. optionally computes a new version from an increment shortcut
4. switches to `main` 4. displays the chosen release tag
5. merges `dev` into `main` 5. asks for confirmation before any Git action
6. pushes `main` 6. switches to `main`
7. creates an annotated tag 7. merges `dev` into `main`
8. pushes tags 8. pushes `main`
9. switches back to the original branch on exit 9. creates an annotated tag
10. pushes tags
11. switches back to the original branch on exit
### Usage ### Usage
@@ -81,6 +83,7 @@ sudo ./fullupgrade
- `VERSION` is used directly as the tag name. - `VERSION` is used directly as the tag name.
- If `VERSION` starts with `+`, it is treated as an increment based on the latest existing tag. - If `VERSION` starts with `+`, it is treated as an increment based on the latest existing tag.
- `--dry-run` can be used from any branch and only prints the computed tag. - `--dry-run` can be used from any branch and only prints the computed tag.
- In normal mode, the computed tag is shown and a confirmation is required before Git actions run.
- The script may fail if Git state is unexpected or if a tag already exists. - The script may fail if Git state is unexpected or if a tag already exists.
- The tag message is automatically generated as `Release <version>`. - The tag message is automatically generated as `Release <version>`.
+11
View File
@@ -114,6 +114,17 @@ if [ "${is_dry_run}" = true ]; then
exit 0 exit 0
fi 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}" git checkout "${TAGBRANCH}"
CURRENTBRANCH="${TAGBRANCH}" CURRENTBRANCH="${TAGBRANCH}"
git merge "${ORIGBRANCH}" git merge "${ORIGBRANCH}"