From f9ae141fa28026bf8d3137e4318502a0f5515145 Mon Sep 17 00:00:00 2001 From: Angela Tran Date: Wed, 15 May 2024 18:13:00 -0500 Subject: [PATCH 1/2] chore: update docs on tagging a release we have been using annotated tags, so this updates our docs to reflect that. --- docs/deployment/release.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deployment/release.md b/docs/deployment/release.md index dcd2a0764..cee6c7e03 100644 --- a/docs/deployment/release.md +++ b/docs/deployment/release.md @@ -87,7 +87,7 @@ git checkout prod git reset --hard origin/prod -git tag YYYY.0M.R +git tag -a YYYY.0M.R git push origin YYYY.0M.R ``` From 64c404b89579b1d43e6a4e48a64c03b17ccce4c2 Mon Sep 17 00:00:00 2001 From: Angela Tran Date: Thu, 23 May 2024 12:10:34 -0500 Subject: [PATCH 2/2] docs: add details about tag annotation --- docs/deployment/release.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/deployment/release.md b/docs/deployment/release.md index cee6c7e03..3fa542cad 100644 --- a/docs/deployment/release.md +++ b/docs/deployment/release.md @@ -88,7 +88,11 @@ git checkout prod git reset --hard origin/prod 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 ```