Chore: update docs on tagging a release #2104
Conversation
we have been using annotated tags, so this updates our docs to reflect that.
github-actions
bot
added
documentation
Coverage report
Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||||||||||||||||||||
|
Preview url: https://benefits-2104--cal-itp-previews.netlify.app |
There was a problem hiding this comment.
Thanks for creating this PR @angela-tran ! I added a few more details about the annotation message as a suggested change. The suggested change preview looks a little weird but hopefully the raw text is clear.
| @@ -87,7 +87,7 @@ git checkout prod | |||
|
|
|||
| git reset --hard origin/prod | |||
|
|
|||
| git tag YYYY.0M.R | |||
| git tag -a YYYY.0M.R | |||
|
|
|||
There was a problem hiding this comment.
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:
There was a problem hiding this comment.
Good idea to add more details on this! I see what you mean with the raw text. I'll make that change
We have been using annotated tags, so this updates our docs to reflect that.