GeezerVison is showing github.com — doc: improve release guide · nodejs/node@4cba432
File tree
Expand file treeCollapse file tree
Open diff view settings
Expand file treeCollapse file tree
Open diff view settings
Collapse file
Copy file name to clipboardExpand all lines: doc/releases.md +9Lines changed: 9 additions & 0 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -157,6 +157,15 @@ were first added in this version. The relevant commits should already include |
157 | 157 | `sed -i "s/REPLACEME/$VERSION/g" doc/api/*.md` or |
158 | 158 | `perl -pi -e "s/REPLACEME/$VERSION/g" doc/api/*.md`. |
159 | 159 |
|
| 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 | + |
160 | 169 | ### 4. Create Release Commit |
161 | 170 |
|
162 | 171 | The `CHANGELOG.md`, `doc/changelogs/CHANGELOG_*.md`, `src/node_version.h`, and |
|