diff options
| author | James M Snell <jasnell@gmail.com> | 2017-08-09 01:00:17 +0300 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2017-08-16 10:04:03 +0300 |
| commit | eac0147085edc83aeb1e96489ed837e7a9585bba (patch) | |
| tree | eb4107197cb6406621495f1d5936f90489c02bfc /doc/releases.md | |
| parent | 1fe0741e50b19ffaaabc77c3a8b99355dc3d28fe (diff) | |
tools: checkout for unassigned DEP00XX codes
Check for `DEP00XX` codes on release build like we do with `REPLACEME`
PR-URL: https://github.com/nodejs/node/pull/14702
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Diffstat (limited to 'doc/releases.md')
| -rw-r--r-- | doc/releases.md | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/releases.md b/doc/releases.md index d2dd317fdb4..d1eeb058760 100644 --- a/doc/releases.md +++ b/doc/releases.md @@ -144,7 +144,7 @@ is shown in **bold** in the index. When updating the index, please make sure to update the display accordingly by removing the bold styling from the previous release. -#### Step 3: Update any REPLACEME tags in the docs +#### Step 3: Update any REPLACEME and DEP00XX tags in the docs If this release includes new APIs then it is necessary to document that they were first added in this version. The relevant commits should already include @@ -154,6 +154,13 @@ 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`. +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 |