Skip to content

Commit fbbc4e5

Browse files
committed
doc: document release types in readme
PR-URL: #3482 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]>
1 parent d28c35a commit fbbc4e5

File tree

1 file changed

+40
-8
lines changed

1 file changed

+40
-8
lines changed

README.md

+40-8
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,58 @@ We intend to land, with increasing regularity, releases which are
1313
compatible with the npm ecosystem that has been built to date for
1414
Node.js.
1515

16+
## Release Types
17+
18+
The Node.js project maintains multiple types of releases:
19+
20+
* **Stable**: Released from active development branches of this repository,
21+
versioned by [SemVer](http://semver.org/) and signed by a member of the
22+
[Release Team](#release-team).
23+
Code for Stable releases is organized in this repository by major version
24+
number, For example: [v4.x](https://github.com/nodejs/node/tree/v4.x).
25+
The major version number of Stable releases will increment every 6 months
26+
allowing for breaking changes to be introduced. This happens in April and
27+
October every year. Stable release lines beginning in October each year have
28+
a maximum support life of 8 months. Stable release lines beginning in April
29+
each year will convert to LTS (see below) after 6 months and receive further
30+
support for 30 months.
31+
* **LTS**: Releases that receive Long-term Support, with a focus on stability
32+
and security. Every second Stable release line (major version) will become an
33+
LTS line and receive 18 months of _Active LTS_ support and a further 12
34+
months of _Maintenance_. LTS release lines are given alphabetically
35+
ordered codenames, begining with v4 Argon. LTS releases are less frequent
36+
and will attempt to maintain consistent major and minor version numbers,
37+
only incrementing patch version numbers. There are no breaking changes or
38+
feature additions, except in some special circumstances. More information
39+
can be found in the [LTS README](https://github.com/nodejs/LTS/).
40+
* **Nightly**: Versions of code in this repository on the current Stable
41+
branch, automatically built every 24-hours where changes exist. Use with
42+
caution.
43+
1644
## Download
1745

1846
Binaries, installers, and source tarballs are available at
1947
<https://nodejs.org>.
2048

21-
**Releases** are available at <https://nodejs.org/dist/>, listed under
22-
their version string. The <https://nodejs.org/dist/latest/> symlink
23-
will point to the latest release directory.
49+
**Stable** and **LTS** releases are available at
50+
<https://nodejs.org/download/release/>, listed under their version strings.
51+
The [latest](https://nodejs.org/download/release/latest/) directory is an
52+
alias for the latest Stable release. The latest LTS release from an LTS
53+
line is available in the form: latest-lts-_codename_. For example:
54+
<https://nodejs.org/download/release/latest-lts-argon>
2455

2556
**Nightly** builds are available at
2657
<https://nodejs.org/download/nightly/>, listed under their version
2758
string which includes their date (in UTC time) and the commit SHA at
2859
the HEAD of the release.
2960

3061
**API documentation** is available in each release and nightly
31-
directory under _docs_. <https://nodejs.org/api/> points to the latest version.
62+
directory under _docs_. <https://nodejs.org/api/> points to the API
63+
documentation of the latest stable version.
3264

3365
### Verifying Binaries
3466

35-
Release and nightly download directories all contain a *SHASUM256.txt*
67+
Stable, LTS and Nightly download directories all contain a *SHASUM256.txt*
3668
file that lists the SHA checksums for each file available for
3769
download. To check that a downloaded file matches the checksum, run
3870
it through `sha256sum` with a command such as:
@@ -44,9 +76,9 @@ $ grep node-vx.y.z.tar.gz SHASUMS256.txt | sha256sum -c -
4476
_(Where "node-vx.y.z.tar.gz" is the name of the file you have
4577
downloaded)_
4678

47-
Additionally, releases (not nightlies) have GPG signed copies of
48-
SHASUM256.txt files available as SHASUM256.txt.asc. You can use `gpg`
49-
to verify that the file has not been tampered with.
79+
Additionally, Stable and LTS releases (not Nightlies) have GPG signed
80+
copies of SHASUM256.txt files available as SHASUM256.txt.asc. You can use
81+
`gpg` to verify that the file has not been tampered with.
5082

5183
To verify a SHASUM256.txt.asc, you will first need to import all of
5284
the GPG keys of individuals authorized to create releases. They are

0 commit comments

Comments
 (0)