Chore: update docs on tagging a release (#2104)

cal-itp · May 28, 2024 · b5c20c2 · b5c20c2
2 parents 91cb369 + 64c404b
commit b5c20c2
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/docs/deployment/release.md b/docs/deployment/release.md
@@ -87,8 +87,12 @@ git checkout prod
 
 git reset --hard origin/prod
 
-git tag YYYY.0M.R
+git tag -a YYYY.0M.R
+```
+
+Git will open your default text editor and prompt you for the tag annotation. For the tag annotation, use the title of the `release`-tagged Issue that kicked off the release. Finally, after closing the text editor:
 
+```bash
 git push origin YYYY.0M.R
 ```