doc: improve release guide

evanlucas · MylesBorins · commit ed9f2fef7068 · 2018-01-09T03:17:38.000-05:00
Specify that $VERSION should include the `v` when replacing REPLACEME in documentation. PR-URL: #17677 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
diff --git a/doc/releases.md b/doc/releases.md
@@ -157,6 +157,8 @@ were first added in this version. The relevant commits should already include
 `sed -i "s/REPLACEME/$VERSION/g" doc/api/*.md` or
 `perl -pi -e "s/REPLACEME/$VERSION/g" doc/api/*.md`.
 
+*Note*: `$VERSION` should be prefixed with a `v`
+
 If this release includes any new deprecations it is necessary to ensure that
 those are assigned a proper static deprecation code. These are listed in the
 docs (see `doc/api/deprecations.md`) and in the source as `DEP00XX`. The code
