Skip to content

Commit b09c386

Browse files
ruyadornodanielleadams
authored andcommitted
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 <ruyadorno@google.com> PR-URL: #45054 Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Beth Griggs <bethanyngriggs@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
1 parent a8030b9 commit b09c386

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

doc/contributing/releases.md

+18
Original file line numberDiff line numberDiff line change
@@ -721,6 +721,24 @@ Revert all changes that were made to `src/node_version.h`:
721721
$ git checkout --ours HEAD -- src/node_version.h
722722
```
723723

724+
<details>
725+
<summary>Major version release</summary>
726+
727+
On the main branch, instead of reverting changes made to `src/node_version.h`
728+
edit it instead and:
729+
730+
* Increment `NODE_MAJOR_VERSION` by one
731+
* Reset `NODE_PATCH_VERSION` to `0`
732+
* Change `NODE_VERSION_IS_RELEASE` back to `0`
733+
734+
Amend the current commit to apply the changes:
735+
736+
```console
737+
$ git commit --amend
738+
```
739+
740+
</details>
741+
724742
Even if there are no conflicts, ensure that you revert all the changes that were
725743
made to `src/node_version.h`.
726744

0 commit comments

Comments
 (0)