Skip to content

Commit

Permalink
doc: add directions to mark a release line as lts
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Danielle Adams authored and codebytere committed Mar 17, 2020
1 parent 67a5b05 commit e791941
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions doc/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ official release builds for Node.js, hosted on <https://nodejs.org/>.
* [17. Cleanup](#17-cleanup)
* [18. Announce](#18-announce)
* [19. Celebrate](#19-celebrate)
* [LTS Releases](#lts-releases)
* [Major Releases](#major-releases)

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

_In whatever form you do this..._

## LTS Releases

### Marking a Release Line as LTS

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

* The `NODE_MINOR_VERSION` macro must be incremented by one
* The `NODE_PATCH_VERSION` macro must be set to `0`
* The `NODE_VERSION_IS_LTS` macro must be set to `1`
* The `NODE_VERSION_LTS_CODENAME` macro must be set to the codename selected
for the LTS release.

For example:

```diff
-#define NODE_MINOR_VERSION 12
-#define NODE_PATCH_VERSION 1
+#define NODE_MINOR_VERSION 13
+#define NODE_PATCH_VERSION 0

-#define NODE_VERSION_IS_LTS 0
-#define NODE_VERSION_LTS_CODENAME ""
+#define NODE_VERSION_IS_LTS 1
+#define NODE_VERSION_LTS_CODENAME "Erbium"

-#define NODE_VERSION_IS_RELEASE 0
+#define NODE_VERSION_IS_RELEASE 1
```

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

## Major Releases

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

0 comments on commit e791941

Please sign in to comment.