Commit c1d5f2e
doc: update releases.md with new changelog structure
PR-URL: #6503
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Robert Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>1 parent d962fba commit c1d5f2e
1 file changed
Lines changed: 28 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -89,7 +89,9 @@ The general rule is to bump this version when there are _breaking ABI_ changes a | |||
| 89 | 89 | ||
| 90 | 90 | **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. | |
| 91 | 91 | ||
| 92 | - ### 3. Update `CHANGELOG.md` | ||
| 92 | + ### 3. Update the Changelog | ||
| 93 | + | ||
| 94 | + #### Step 1: Collecting the formatted list of changes: | ||
| 93 | 95 | ||
| 94 | 96 | Collect a formatted list of commits since the last release. Use [`changelog-maker`](https://github.com/rvagg/changelog-maker) to do this. | |
| 95 | 97 | ||
@@ -103,9 +105,20 @@ Note that changelog-maker counts commits since the last tag and if the last tag | |||
| 103 | 105 | $ changelog-maker --group --start-ref v2.3.1 | |
| 104 | 106 | ``` | |
| 105 | 107 | ||
| 106 | - The `CHANGELOG.md` entry should take the following form: | ||
| 108 | + #### Step 2: Update the appropriate doc/changelogs/CHANGELOG_*.md file | ||
| 109 | + | ||
| 110 | + There is a separate `CHANGELOG_*.md` file for each major Node.js release line. | ||
| 111 | + These are located in the `doc/changelogs/` directory. Once the formatted list | ||
| 112 | + of changes is collected, it must be added to the top of the relevant changelog | ||
| 113 | + file in the release branch (e.g. a release for Node.js v4 would be added to the | ||
| 114 | + `/doc/changelogs/CHANGELOG_V4.md`). | ||
| 115 | + | ||
| 116 | + **Please do *not* add the changelog entries to the root `CHANGELOG.md` file.** | ||
| 117 | + | ||
| 118 | + The new entry should take the following form: | ||
| 107 | 119 | ||
| 108 | 120 | ``` | |
| 121 | + <a id="x.y.x></a>" | ||
| 109 | 122 | ## YYYY-MM-DD, Version x.y.z (Release Type), @releaser | |
| 110 | 123 | ||
| 111 | 124 | ### Notable changes | |
@@ -115,23 +128,28 @@ The `CHANGELOG.md` entry should take the following form: | |||
| 115 | 128 | * Also be sure to look at any changes introduced by dependencies such as npm | |
| 116 | 129 | * ... and include any notable items from there | |
| 117 | 130 | ||
| 118 | - ### Known issues | ||
| 119 | - | ||
| 120 | - See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. | ||
| 121 | - | ||
| 122 | - * Include this section if there are any known problems with this release | ||
| 123 | - * Scan GitHub for unresolved problems that users may need to be aware of | ||
| 124 | - | ||
| 125 | 131 | ### Commits | |
| 126 | 132 | ||
| 127 | 133 | * Include the full list of commits since the last release here. Do not include "Working on X.Y.Z+1" commits. | |
| 128 | 134 | ``` | |
| 129 | 135 | ||
| 130 | 136 | The release type should be either Current, LTS, or Maintenance, depending on the type of release being produced. | |
| 131 | 137 | ||
| 138 | + At the top of each `CHANGELOG_*.md` file, and in the root `CHANGELOG.md` file, | ||
| 139 | + there is a table indexing all releases in each major release line. A link to | ||
| 140 | + the new release needs to be added to each. Follow the existing examples and be | ||
| 141 | + sure to add the release to the *top* of the list. | ||
| 142 | + | ||
| 143 | + In the root `CHANGELOG.md` file, the most recent release for each release line | ||
| 144 | + is shown in **bold** in the index. When updating the index, please make sure | ||
| 145 | + to update the display accordingly by removing the bold styling from the previous | ||
| 146 | + release. | ||
| 147 | + | ||
| 132 | 148 | ### 4. Create Release Commit | |
| 133 | 149 | ||
| 134 | - The `CHANGELOG.md` and `src/node_version.h` changes should be the final commit that will be tagged for the release. When committing these to git, use the following message format: | ||
| 150 | + The `CHANGELOG.md`, `doc/changelogs/CHANGELOG_*.md`, and `src/node_version.h` | ||
| 151 | + changes should be the final commit that will be tagged for the release. When | ||
| 152 | + committing these to git, use the following message format: | ||
| 135 | 153 | ||
| 136 | 154 | ``` | |
| 137 | 155 | YYYY-MM-DD, Version x.y.z (Release Type) | |
0 commit comments