Skip to content

Commit

Permalink
doc: add major version note to release guide
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
ruyadorno authored and anonrig committed Oct 22, 2022
1 parent 47b63f5 commit 58cfb32
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions doc/contributing/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down

0 comments on commit 58cfb32

Please sign in to comment.