From 741e5b2912776955be0c8fd4a607570c19b37aee 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 | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/releases.md b/doc/releases.md index 339ee291508554..eec99ea3d5181c 100644 --- a/doc/releases.md +++ b/doc/releases.md @@ -157,6 +157,15 @@ 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 +must be assigned a number (e.g. `DEP0012`). Note that this assignment should +occur when the PR is landed, but a check will be made when the release built +is run. + ### 4. Create Release Commit The `CHANGELOG.md`, `doc/changelogs/CHANGELOG_*.md`, `src/node_version.h`, and