From ceb36040e39d437e196627348cc70f02989720e3 Mon Sep 17 00:00:00 2001 From: Ruy Adorno Date: Tue, 18 Oct 2022 10:29:38 -0400 Subject: [PATCH] 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 --- doc/contributing/releases.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/contributing/releases.md b/doc/contributing/releases.md index 4e7ac323d233e6..5c54003be86bfa 100644 --- 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 ``` +
+Major version release + +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 +``` + +
+ Even if there are no conflicts, ensure that you revert all the changes that were made to `src/node_version.h`.