Skip to content

Commit

Permalink
doc: document release types in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rvagg committed Oct 22, 2015
1 parent 6fa5df9 commit 8beb278
Showing 1 changed file with 38 additions and 8 deletions.
46 changes: 38 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,56 @@ The Node.js project is supported by the
policies and releases are managed under an
[open governance model](./GOVERNANCE.md).

## Release Types

The Node.js project maintains multiple types of releases:

* **Stable**: planned and signed releases. Released from active development
branches of this repository and versioned by [SemVer](http://semver.org/).
Code for Stable releases are organized in this repository by major version
number, e.g. [v4.x](https://github.com/nodejs/node/tree/v4.x).
The major version number of Stable releases will increment every 6 months
allowing for breaking changes to be introduced, this happens in April and
October every year. Stable release lines beginning in October each year have
a maximum support life of 8 months. Stable release lines beginning in April
each year will convert to LTS (see below) after 6 months and receive further
support for 30 months.
* **LTS**: Every second Stable release line (major version) will become LTS
lines and receive 18 months of _Active LTS_ support and a further 12
months of _Maintenance_. LTS release lines are given alphabetically
ordered codenames, begining with v4 "Argon". LTS releases are less frequent
and will attempt to maintain consistent major and minor version numbers,
only incrementing patch version numbers. i.e. no breaking changes or
feature additions. More information can be found in the
[LTS README](https://github.com/nodejs/LTS/).
* **Nightly**: versions of code in this repository on the current Stable
branch, automatically built every 24-hours where changes exist. Use with
caution.

## Download

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

**Releases** are available at <https://nodejs.org/dist/>, listed under
their version string. The <https://nodejs.org/dist/latest/> symlink
will point to the latest release directory.
**Stable** and **LTS** releases are available at
<https://nodejs.org/download/release/>, listed under their version string.
The [latest](https://nodejs.org/download/release/latest/) directory is an
alias for the latest Stable release. The latest LTS release from an LTS
line is available in the form: latest-lts-_codename_. e.g.
<https://nodejs.org/download/release/latest-lts-argon>

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

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

### Verifying Binaries

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

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

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

0 comments on commit 8beb278

Please sign in to comment.