diff --git a/doc/releases.md b/doc/releases.md index b7e0068369..7dcf99c700 100644 --- a/doc/releases.md +++ b/doc/releases.md @@ -89,7 +89,9 @@ The general rule is to bump this version when there are _breaking ABI_ changes a **Note** that it is current TSC policy to bump major version when ABI changes. If you see a need to bump `NODE_MODULE_VERSION` then you should consult the TSC. Commits may need to be reverted or a major version bump may need to happen. -### 3. Update `CHANGELOG.md` +### 3. Update the Changelog + +#### Step 1: Collecting the formatted list of changes: Collect a formatted list of commits since the last release. Use [`changelog-maker`](https://github.com/rvagg/changelog-maker) to do this. @@ -103,9 +105,20 @@ Note that changelog-maker counts commits since the last tag and if the last tag $ changelog-maker --group --start-ref v2.3.1 ``` -The `CHANGELOG.md` entry should take the following form: +#### Step 2: Update the appropriate doc/changelogs/CHANGELOG_*.md file + +There is a separate `CHANGELOG_*.md` file for each major Node.js release line. +These are located in the `doc/changelogs/` directory. Once the formatted list +of changes is collected, it must be added to the top of the relevant changelog +file in the release branch (e.g. a release for Node.js v4 would be added to the +`/doc/changelogs/CHANGELOG_V4.md`). + +**Please do *not* add the changelog entries to the root `CHANGELOG.md` file.** + +The new entry should take the following form: ``` +