From 8beb27815fcfe6a9ebce6bb9df666b9b9a2bb5db Mon Sep 17 00:00:00 2001 From: Rod Vagg Date: Thu, 22 Oct 2015 00:47:36 -0400 Subject: [PATCH] doc: document release types in readme --- README.md | 46 ++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 38 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a376f634ab2eea..2613e21a8dbe78 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,43 @@ 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 . -**Releases** are available at , listed under -their version string. The symlink -will point to the latest release directory. +**Stable** and **LTS** releases are available at +, 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. + **Nightly** builds are available at , listed under their version @@ -23,11 +52,12 @@ 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_. points to the latest version. +directory under _docs_. 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: @@ -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