docs: document release confirmation step

This commit is contained in:
2026-04-27 20:40:46 +02:00
parent 09f81b8e7c
commit d9b322a1c5
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`
- verifies the working tree is clean
- 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`
- merges `dev` into `main`
- pushes the branch
@@ -49,9 +51,10 @@ Current behavior:
Notes:
- 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 current increment logic assumes simple dotted numeric tags
- normal releases now require an interactive confirmation after the tag is displayed
Recommendations:
- consider validating the version format more strictly if release rules grow
@@ -60,7 +63,7 @@ Recommendations:
### 3) `README.md`
Current status:
- 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:
- keep it aligned with the actual script behavior