Skip to content

Commit b56a21f

Browse files
Danielle Adamscodebytere
authored andcommitted
doc: add directions to mark a release line as lts
Moves directions for LTS release from the Release repo to Node docs. Fixes: nodejs/Release#530 PR-URL: #31724 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
1 parent 5ae40cd commit b56a21f

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

doc/releases.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ official release builds for Node.js, hosted on <https://nodejs.org/>.
3232
* [17. Cleanup](#17-cleanup)
3333
* [18. Announce](#18-announce)
3434
* [19. Celebrate](#19-celebrate)
35+
* [LTS Releases](#lts-releases)
3536
* [Major Releases](#major-releases)
3637

3738
## Who can make a release?
@@ -672,6 +673,38 @@ Ping the IRC ops and the other [Partner Communities][] liaisons.
672673

673674
_In whatever form you do this..._
674675

676+
## LTS Releases
677+
678+
### Marking a Release Line as LTS
679+
680+
To mark a release line as LTS, the following changes must be made to
681+
`src/node_version.h`:
682+
683+
* The `NODE_MINOR_VERSION` macro must be incremented by one
684+
* The `NODE_PATCH_VERSION` macro must be set to `0`
685+
* The `NODE_VERSION_IS_LTS` macro must be set to `1`
686+
* The `NODE_VERSION_LTS_CODENAME` macro must be set to the codename selected
687+
for the LTS release.
688+
689+
For example:
690+
691+
```diff
692+
-#define NODE_MINOR_VERSION 12
693+
-#define NODE_PATCH_VERSION 1
694+
+#define NODE_MINOR_VERSION 13
695+
+#define NODE_PATCH_VERSION 0
696+
697+
-#define NODE_VERSION_IS_LTS 0
698+
-#define NODE_VERSION_LTS_CODENAME ""
699+
+#define NODE_VERSION_IS_LTS 1
700+
+#define NODE_VERSION_LTS_CODENAME "Erbium"
701+
702+
-#define NODE_VERSION_IS_RELEASE 0
703+
+#define NODE_VERSION_IS_RELEASE 1
704+
```
705+
706+
The changes must be made as part of a new semver-minor release.
707+
675708
## Major Releases
676709

677710
The process for cutting a new Node.js major release has a number of differences

0 commit comments

Comments
 (0)