Skip to content

Commit

Permalink
doc: improve release guide
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
evanlucas authored and MylesBorins committed Feb 13, 2018
1 parent 423ef3d commit 4cba432
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions doc/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4cba432

Please sign in to comment.