docs: note tag.gpgsign requires -m flag on tag creation

Learned the hard way on the v1.0.0 release — this repo inherits
tag.gpgsign=true from global config, so `git tag v1.0.0` fails
with "no tag message?" rather than creating a lightweight tag.
Update the release recipe to use -m explicitly.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-04-16 15:23:19 +03:00
parent cc1a164bc1
commit 22e2e34724

View File

@@ -32,12 +32,14 @@ major-version tag and an immutable semver tag.
2. Determine the next version by bumping the patch or minor from the 2. Determine the next version by bumping the patch or minor from the
latest semver tag (e.g. `v1.0.3``v1.0.4` for a fix, `v1.1.0` latest semver tag (e.g. `v1.0.3``v1.0.4` for a fix, `v1.1.0`
for a non-breaking feature). for a non-breaking feature).
3. Tag and push. Both the immutable semver tag and the moving major 3. Tag and push. This repo has `tag.gpgsign=true` globally, so tags
tag get pushed in the same command: must be annotated with a message (`-m`) and a GPG key must be
available. Both the immutable semver tag and the moving major tag
get pushed in the same release:
```sh ```sh
git tag v1.0.4 git tag -m "v1.0.4" v1.0.4
git tag -f v1 git tag -f -m "v1 - track latest v1.x.y" v1
git push origin main git push origin main
git push origin v1.0.4 git push origin v1.0.4
git push origin v1 --force git push origin v1 --force
@@ -53,8 +55,8 @@ major-version tag and an immutable semver tag.
2. Cut a new major tag (`v2.0.0`) and a new major-line tag (`v2`): 2. Cut a new major tag (`v2.0.0`) and a new major-line tag (`v2`):
```sh ```sh
git tag v2.0.0 git tag -m "v2.0.0" v2.0.0
git tag v2 git tag -m "v2 - track latest v2.x.y" v2
git push origin main v2.0.0 v2 git push origin main v2.0.0 v2
``` ```