Skip to content

Commit

Permalink
doc: update mark release line lts on release guide
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
ruyadorno authored and RafaelGSS committed Nov 10, 2022
1 parent 4e14ed8 commit 85cb4d7
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions doc/contributing/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -961,6 +961,31 @@ _In whatever form you do this..._

### Marking a release line as LTS

The process of marking a release line as LTS has been automated using
[node-core-utils](https://github.com/nodejs/node-core-utils).

Start by checking out the staging branch for the release line that is going to
be marked as LTS, e.g:

```console
$ git checkout v1.x-staging
```

Next, make sure you have **node-core-utils** installed:

```console
$ npm i -g node-core-utils
```

Run the prepare LTS release command:

```console
$ git node release --prepare --startLTS
```

<details>
<summary>Manual steps for reference.</summary>

To mark a release line as LTS, the following changes must be made to
`src/node_version.h`:

Expand Down Expand Up @@ -989,6 +1014,18 @@ For example:

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

Updating changelogs to properly reflect the changes between **Current** and
**Long Term Support** is also necessary, along with adding a reference to the
current LTS codename in its release line changelog file.

The `test/parallel/test-process-release.js` file might also need to be updated.

In case you can not run the automated `node-core-utils` command and you are
currently running these steps manually it's a good idea to refer to previous
LTS proposal PRs and make sure all required changes are covered.

</details>

### Update release labels

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

0 comments on commit 85cb4d7

Please sign in to comment.