diff options
| author | Evan Lucas <evanlucas@me.com> | 2017-12-14 05:29:46 -0600 |
|---|---|---|
| committer | Evan Lucas <evanlucas@me.com> | 2017-12-18 14:20:30 -0600 |
| commit | 7688a8bd1fb930cc8ebebeea92de0124fca4223b (patch) | |
| tree | 16917ca69c66ed2b0ab1f70f4ab451b2be87788f | |
| parent | 94e29510d93811ff0792260a6c2ec3f72f43558c (diff) | |
| download | android-node-v8-7688a8bd1fb930cc8ebebeea92de0124fca4223b.tar.gz android-node-v8-7688a8bd1fb930cc8ebebeea92de0124fca4223b.tar.bz2 android-node-v8-7688a8bd1fb930cc8ebebeea92de0124fca4223b.zip | |
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>
| -rw-r--r-- | doc/releases.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/releases.md b/doc/releases.md index fd38e073d8..36bdef8325 100644 --- 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 |