From eac0147085edc83aeb1e96489ed837e7a9585bba Mon Sep 17 00:00:00 2001 From: James M Snell Date: Tue, 8 Aug 2017 15:00:17 -0700 Subject: [PATCH] tools: checkout for unassigned DEP00XX codes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-By: Tobias Nießen --- Makefile | 5 +++++ doc/releases.md | 9 ++++++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 652c591e2bfe96..ced319ee68f550 100644 --- a/Makefile +++ b/Makefile @@ -672,6 +672,11 @@ release-only: echo 'Please update REPLACEME in Added: tags in doc/api/*.md (See doc/releases.md)' ; \ exit 1 ; \ fi + @if [ "$(DISTTYPE)" != "nightly" ] && [ "$(DISTTYPE)" != "next-nightly" ] && \ + `grep -q DEP00XX doc/api/deprecations.md`; then \ + echo 'Please update DEP00XX in doc/api/deprecations.md (See doc/releases.md)' ; \ + exit 1 ; \ + fi @if [ "$(shell git status --porcelain | egrep -v '^\?\? ')" = "" ]; then \ exit 0 ; \ else \ diff --git a/doc/releases.md b/doc/releases.md index d2dd317fdb416b..d1eeb05876085c 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