Skip to content

Commit 9da6c10

Browse files
jasnellMylesBorins
authored andcommitted
tools: checkout for unassigned DEP00XX codes
Check for `DEP00XX` codes on release build like we do with `REPLACEME` PR-URL: #14702 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Tobias Nießen <[email protected]>
1 parent 4d2aa16 commit 9da6c10

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

Makefile

+5
Original file line numberDiff line numberDiff line change
@@ -672,6 +672,11 @@ release-only:
672672
echo 'Please update REPLACEME in Added: tags in doc/api/*.md (See doc/releases.md)' ; \
673673
exit 1 ; \
674674
fi
675+
@if [ "$(DISTTYPE)" != "nightly" ] && [ "$(DISTTYPE)" != "next-nightly" ] && \
676+
`grep -q DEP00XX doc/api/deprecations.md`; then \
677+
echo 'Please update DEP00XX in doc/api/deprecations.md (See doc/releases.md)' ; \
678+
exit 1 ; \
679+
fi
675680
@if [ "$(shell git status --porcelain | egrep -v '^\?\? ')" = "" ]; then \
676681
exit 0 ; \
677682
else \

doc/releases.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ is shown in **bold** in the index. When updating the index, please make sure
144144
to update the display accordingly by removing the bold styling from the previous
145145
release.
146146

147-
#### Step 3: Update any REPLACEME tags in the docs
147+
#### Step 3: Update any REPLACEME and DEP00XX tags in the docs
148148

149149
If this release includes new APIs then it is necessary to document that they
150150
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
154154
`sed -i "s/REPLACEME/$VERSION/g" doc/api/*.md` or
155155
`perl -pi -e "s/REPLACEME/$VERSION/g" doc/api/*.md`.
156156

157+
If this release includes any new deprecations it is necessary to ensure that
158+
those are assigned a proper static deprecation code. These are listed in the
159+
docs (see `doc/api/deprecations.md`) and in the source as `DEP00XX`. The code
160+
must be assigned a number (e.g. `DEP0012`). Note that this assignment should
161+
occur when the PR is landed, but a check will be made when the release built
162+
is run.
163+
157164
### 4. Create Release Commit
158165

159166
The `CHANGELOG.md`, `doc/changelogs/CHANGELOG_*.md`, `src/node_version.h`, and

0 commit comments

Comments
 (0)