From e6d1cdf1c46f1204e589ec79447b96cece9d1047 Mon Sep 17 00:00:00 2001 From: Ruy Adorno <ruyadorno@google.com> Date: Thu, 20 Oct 2022 17:58:56 -0400 Subject: [PATCH 1/5] 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> --- doc/contributing/releases.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/doc/contributing/releases.md b/doc/contributing/releases.md index 4e7ac323d233e6..ce8c0f71a8d56c 100644 --- a/doc/contributing/releases.md +++ b/doc/contributing/releases.md @@ -941,6 +941,30 @@ _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`: @@ -969,6 +993,17 @@ 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 From c8653ea4a74121b847792ee5ca8ad36af705b21c Mon Sep 17 00:00:00 2001 From: Ruy Adorno <ruyadorno@google.com> Date: Fri, 21 Oct 2022 11:16:19 -0400 Subject: [PATCH 2/5] Update doc/contributing/releases.md Co-authored-by: Rafael Gonzaga <rafael.nunu@hotmail.com> --- doc/contributing/releases.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing/releases.md b/doc/contributing/releases.md index ce8c0f71a8d56c..1354cfd4c4b450 100644 --- a/doc/contributing/releases.md +++ b/doc/contributing/releases.md @@ -954,7 +954,7 @@ $ git checkout v1.x-staging Next, make sure you have **node-core-utils** installed: ```console -npm i -g node-core-utils +$ npm i -g node-core-utils ``` Run the prepare LTS release command: From 7c0a5cb6387217ca88ddeed2dc9c5102177d364b Mon Sep 17 00:00:00 2001 From: Ruy Adorno <ruyadorno@google.com> Date: Fri, 21 Oct 2022 11:16:25 -0400 Subject: [PATCH 3/5] Update doc/contributing/releases.md Co-authored-by: Rafael Gonzaga <rafael.nunu@hotmail.com> --- doc/contributing/releases.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing/releases.md b/doc/contributing/releases.md index 1354cfd4c4b450..8e901c15388a1c 100644 --- a/doc/contributing/releases.md +++ b/doc/contributing/releases.md @@ -960,7 +960,7 @@ $ npm i -g node-core-utils Run the prepare LTS release command: ```console -git node release --prepare --startLTS +$ git node release --prepare --startLTS ``` <details> From 25b4ccfe9990c28015f67a12071162b64a1841b8 Mon Sep 17 00:00:00 2001 From: Ruy Adorno <ruyadorno@google.com> Date: Fri, 21 Oct 2022 15:12:42 -0400 Subject: [PATCH 4/5] Update doc/contributing/releases.md --- doc/contributing/releases.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/contributing/releases.md b/doc/contributing/releases.md index 8e901c15388a1c..ea5af76fa306ef 100644 --- a/doc/contributing/releases.md +++ b/doc/contributing/releases.md @@ -1002,6 +1002,7 @@ 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 From 520e533dffd08d05264ff4dcf2e7ab8f40f573c2 Mon Sep 17 00:00:00 2001 From: Ruy Adorno <ruyadorno@google.com> Date: Mon, 24 Oct 2022 11:33:27 -0400 Subject: [PATCH 5/5] Update doc/contributing/releases.md Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com> --- doc/contributing/releases.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/contributing/releases.md b/doc/contributing/releases.md index ea5af76fa306ef..c5830375ec6e94 100644 --- a/doc/contributing/releases.md +++ b/doc/contributing/releases.md @@ -965,6 +965,7 @@ $ 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`: