docs: add a reminder to keep local git in sync before tagging

Add a reminder to keep get the latest changes from upstream before
making the git tag. I was out of date today on my laptop and while I did
remember to do it on my own - adding a hint for the future just makes
future mistakes a tad less likely.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
This commit is contained in:
John Mulligan 2022-10-17 09:12:54 -04:00 committed by mergify[bot]
parent 54918abb0f
commit 5faf2949d5
1 changed files with 3 additions and 0 deletions

View File

@ -16,11 +16,14 @@ The sections below go into more detail about these steps in no particular order.
## Tagging a Major-Minor release ## Tagging a Major-Minor release
First, make sure your local git tree has the latest changes.
Tag master branch with a vX.Y.Z version. This should be an annotated tag (it Tag master branch with a vX.Y.Z version. This should be an annotated tag (it
will have a commit message). will have a commit message).
Example: Example:
```shell ```shell
git checkout master
git pull --ff-only
git tag -a v0.2.0 -m 'Release v0.2.0' git tag -a v0.2.0 -m 'Release v0.2.0'
``` ```