From ed9f2fef706899daf4681c9d8e29fe46893dbe62 Mon Sep 17 00:00:00 2001 From: Evan Lucas Date: Thu, 14 Dec 2017 05:29:46 -0600 Subject: [PATCH] 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 Reviewed-By: James M Snell Reviewed-By: Jeremiah Senkpiel Reviewed-By: Luigi Pinca Reviewed-By: Daniel Bevenius --- doc/releases.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/releases.md b/doc/releases.md index fd38e073d8b52d..36bdef8325acf6 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