doc: add major version note to release guide

Adding a note on how to properly edit the the `src/node_version.h` file when working on the cherry-pick step of the Release Guide when working on a new major version release. Signed-off-by: Ruy Adorno <[email protected]> PR-URL: #45054 Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Beth Griggs <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]>
nodejs · Nov 10, 2022 · 5190021 · 5190021
1 parent 2b3b291
commit 5190021
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/doc/contributing/releases.md b/doc/contributing/releases.md
@@ -721,6 +721,24 @@ Revert all changes that were made to `src/node_version.h`:
 $ git checkout --ours HEAD -- src/node_version.h
 ```
 
+<details>
+<summary>Major version release</summary>
+
+On the main branch, instead of reverting changes made to `src/node_version.h`
+edit it instead and:
+
+* Increment `NODE_MAJOR_VERSION` by one
+* Reset `NODE_PATCH_VERSION` to `0`
+* Change `NODE_VERSION_IS_RELEASE` back to `0`
+
+Amend the current commit to apply the changes:
+
+```console
+$ git commit --amend
+```
+
+</details>
+
 Even if there are no conflicts, ensure that you revert all the changes that were
 made to `src/node_version.h`.