From 17380a1e6ac77cd63c462386e3337be8ba35e526 Mon Sep 17 00:00:00 2001 From: Ruy Adorno Date: Mon, 24 Oct 2022 14:32:40 -0400 Subject: [PATCH] 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 PR-URL: https://github.com/nodejs/node/pull/45101 Reviewed-By: Richard Lau Reviewed-By: Michael Dawson Reviewed-By: Beth Griggs Reviewed-By: Yagiz Nizipli Reviewed-By: James M Snell Reviewed-By: Luigi Pinca Reviewed-By: Antoine du Hamel Reviewed-By: Rafael Gonzaga Reviewed-By: Chengzhong Wu --- doc/contributing/releases.md | 37 ++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/doc/contributing/releases.md b/doc/contributing/releases.md index 5752af3797d8de..f2092f787096e3 100644 --- a/doc/contributing/releases.md +++ b/doc/contributing/releases.md @@ -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 +``` + +
+Manual steps for reference. + To mark a release line as LTS, the following changes must be made to `src/node_version.h`: @@ -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. + +
+ ### Update release labels The `lts-watch-vN.x` issue label must be created, with the same color as other