doc: improve release guide

Specify that $VERSION should include the `v` when replacing
REPLACEME in documentation.

PR-URL: https://github.com/nodejs/node/pull/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>
This commit is contained in:
Evan Lucas 2017-12-14 05:29:46 -06:00
parent 94e29510d9
commit 7688a8bd1f

View File

@ -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 `sed -i "s/REPLACEME/$VERSION/g" doc/api/*.md` or
`perl -pi -e "s/REPLACEME/$VERSION/g" doc/api/*.md`. `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 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 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 docs (see `doc/api/deprecations.md`) and in the source as `DEP00XX`. The code