Skip to content

Commit

Permalink
doc: fix release guide example consistency
Browse files Browse the repository at this point in the history
This changeset fixes two consistency issues in this single example that
guides releasers on how to push the tag to the remote repo.

The first issue is that the remote git reference is consistently
referred as `upstream` elsewhere in the guide.

The second issue being that the version example used in the rest of the
guide should be a fictional `v1.2.3` as stated in the "How to create a
release" guide notes:

>  * Examples will use the fictional release version `1.2.3`.

PR-URL: #44385
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
  • Loading branch information
ruyadorno authored and juanarbol committed Oct 11, 2022
1 parent 7b69172 commit 1998bc8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/contributing/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -744,7 +744,7 @@ haven't pushed your tag first, then build promotion won't work properly.
Push the tag using the following command:

```console
$ git push <remote> <vx.y.z>
$ git push upstream v1.2.3
```

_Note_: Please do not push the tag unless you are ready to complete the
Expand Down

0 comments on commit 1998bc8

Please sign in to comment.