Skip to content

Commit 17380a1

Browse files
ruyadornodanielleadams
authored andcommitted
doc: update mark release line lts on release guide
Updates the Release Guide to point to using `node-core-utils` for creating the commit that marks a release line as LTS. Signed-off-by: Ruy Adorno <ruyadorno@google.com> PR-URL: #45101 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Beth Griggs <bethanyngriggs@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent f748f5d commit 17380a1

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

doc/contributing/releases.md

+37
Original file line numberDiff line numberDiff line change
@@ -961,6 +961,31 @@ _In whatever form you do this..._
961961

962962
### Marking a release line as LTS
963963

964+
The process of marking a release line as LTS has been automated using
965+
[node-core-utils](https://github.com/nodejs/node-core-utils).
966+
967+
Start by checking out the staging branch for the release line that is going to
968+
be marked as LTS, e.g:
969+
970+
```console
971+
$ git checkout v1.x-staging
972+
```
973+
974+
Next, make sure you have **node-core-utils** installed:
975+
976+
```console
977+
$ npm i -g node-core-utils
978+
```
979+
980+
Run the prepare LTS release command:
981+
982+
```console
983+
$ git node release --prepare --startLTS
984+
```
985+
986+
<details>
987+
<summary>Manual steps for reference.</summary>
988+
964989
To mark a release line as LTS, the following changes must be made to
965990
`src/node_version.h`:
966991

@@ -989,6 +1014,18 @@ For example:
9891014

9901015
The changes must be made as part of a new semver-minor release.
9911016

1017+
Updating changelogs to properly reflect the changes between **Current** and
1018+
**Long Term Support** is also necessary, along with adding a reference to the
1019+
current LTS codename in its release line changelog file.
1020+
1021+
The `test/parallel/test-process-release.js` file might also need to be updated.
1022+
1023+
In case you can not run the automated `node-core-utils` command and you are
1024+
currently running these steps manually it's a good idea to refer to previous
1025+
LTS proposal PRs and make sure all required changes are covered.
1026+
1027+
</details>
1028+
9921029
### Update release labels
9931030

9941031
The `lts-watch-vN.x` issue label must be created, with the same color as other

0 commit comments

Comments
 (0)