Skip to content

Commit ed9f2fe

Browse files
evanlucasMylesBorins
authored andcommitted
doc: improve release guide
Specify that $VERSION should include the `v` when replacing REPLACEME in documentation. PR-URL: #17677 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]>
1 parent 79a2833 commit ed9f2fe

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

doc/releases.md

+2
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,8 @@ were first added in this version. The relevant commits should already include
157157
`sed -i "s/REPLACEME/$VERSION/g" doc/api/*.md` or
158158
`perl -pi -e "s/REPLACEME/$VERSION/g" doc/api/*.md`.
159159

160+
*Note*: `$VERSION` should be prefixed with a `v`
161+
160162
If this release includes any new deprecations it is necessary to ensure that
161163
those are assigned a proper static deprecation code. These are listed in the
162164
docs (see `doc/api/deprecations.md`) and in the source as `DEP00XX`. The code

0 commit comments

Comments
 (0)