Skip to content

Commit a759c8f

Browse files
evanlucasMylesBorins
authored andcommitted
doc: improve release guide
Specify that $VERSION should include the `v` when replacing REPLACEME in documentation. PR-URL: #17677 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
1 parent 6e108a5 commit a759c8f

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/releases.md

+9
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,15 @@ were first added in this version. The relevant commits should already include
157157
`sed -i "s/REPLACEME/$VERSION/g" doc/api/*.md` or
158158
`perl -pi -e "s/REPLACEME/$VERSION/g" doc/api/*.md`.
159159

160+
*Note*: `$VERSION` should be prefixed with a `v`
161+
162+
If this release includes any new deprecations it is necessary to ensure that
163+
those are assigned a proper static deprecation code. These are listed in the
164+
docs (see `doc/api/deprecations.md`) and in the source as `DEP00XX`. The code
165+
must be assigned a number (e.g. `DEP0012`). Note that this assignment should
166+
occur when the PR is landed, but a check will be made when the release built
167+
is run.
168+
160169
### 4. Create Release Commit
161170

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

0 commit comments

Comments
 (0)