Skip to content

Commit 55e19aa

Browse files
dgp1130alan-agius4
dgp1130
authored and
alan-agius4
committed
ci: update release docs to use annotated tags for releases
This changes from using lightweight tags to annotated tags. The later includes author, time, and message information that is lacking from the former. It is also included in Git's `--follow-tags` option. This should allow us to push tags alongside release commits more atomically and hopefully eliminate or at least reduce the possibility of a race condition arising from CI starting on the release commit before the associated tag is pushed. Such a state causes CI failures, because they take the latest version from the most recent `v*` tag.
1 parent 6e74b2f commit 55e19aa

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

‎docs/process/release.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ As commits are cherry-picked when PRs are merged, creating the release should be
108108

109109
```bash
110110
git commit -a -m 'release: vXX'
111-
git tag 'vXX'
111+
git tag -a 'vXX' -m 'release: tag vXX'
112112
```
113113

114114
The package versions we are about to publish are derived from the git tag that
@@ -119,11 +119,11 @@ following command.
119119
yarn admin packages --version
120120
```
121121

122-
Now push the commit and the tag to the upstream repository.
123-
**Make sure to run these commands together, as missing tags can cause CI failures.**
122+
Now push the commit and the tag to the upstream repository. **Make sure to use
123+
`--follow-tags, as tags need to be pushed immediately or CI may fail!**
124124

125125
```bash
126-
git push upstream && git push upstream --tags
126+
git push upstream --follow-tags
127127
```
128128

129129
### Authenticating

0 commit comments

Comments
 (0)