Skip to content
Closed
Changes from 1 commit
Commits
Show all changes
108 commits
Select commit Hold shift + click to select a range
d2a487e
Revert "stream: fix .end() error propagation"
mcollina Jan 25, 2021
67c9a8e
doc: improve promise terminology
benjamingr Feb 2, 2021
9946c11
src: read exactly two tokens from Linux THP sysfs config
jayaddison Jan 25, 2021
13fe17c
test: split heap snapshot limit tests
Trott Feb 2, 2021
dc84c18
tls: add ability to get cert/peer cert as X509Certificate object
jasnell Jan 26, 2021
011910b
crypto: add keyObject.export() 'jwk' format option
panva Jan 26, 2021
e63b380
deps: upgrade npm to 7.5.2
ruyadorno Feb 2, 2021
1fea051
stream: improve Readable.from error handling
benjamingr Jan 31, 2021
ff02e5e
doc: fix 404 links in module.md
aduh95 Feb 3, 2021
3f815d9
doc: fix pr-url for DEP0148
aduh95 Feb 3, 2021
745aad7
tools: update ESLint to 7.19.0
cjihrig Jan 31, 2021
bfe0b46
src: simplify calls to BN_bin2bn in prime gen
tniessen Feb 1, 2021
4ebe38b
timers: introduce setInterval async iterator
Linkgoron Jan 30, 2021
5157525
test: remove flaky designation for test-http2-large-file
Trott Jan 31, 2021
b87c0d6
doc: fix typo in cli.md
0xkalvin Feb 3, 2021
4cdc5ea
http: fix ClientRequest unhandled errors
ronag Jan 16, 2021
48ce1eb
src: fix warning in string_search.h
RaisinTen Jan 30, 2021
eb08afd
doc: fix typo in globals.md
RaisinTen Feb 4, 2021
eb7ec1b
timers: remove flaky setInterval test
Feb 4, 2021
c377834
repl: refactor to avoid unsafe array iteration
aduh95 Feb 2, 2021
52c40c7
doc: fix CHANGELOG_ARCHIVE table of contents
aduh95 Feb 4, 2021
5906e85
doc: fix version number for DEP006
aduh95 Feb 4, 2021
acd087d
fs: add AbortSignal support to watch
benjamingr Feb 2, 2021
2a5f67b
src: refactor bookkeeping of bootstrap status
joyeecheung Jan 28, 2021
337b4e7
src: put (de)serialization code into node_snapshotable.h/cc
joyeecheung Jan 28, 2021
8a25405
doc: fix accommodate typos
cjihrig Feb 4, 2021
66a14d3
vm: add importModuleDynamically option to compileFunction
devsnek Sep 25, 2020
655d196
fs: use a default callback for fs.close()
jasnell Feb 1, 2021
0702d60
doc: fix webcrypto HMAC generateKey example
panva Feb 3, 2021
596bfb3
doc: mention CryptoKey in port.postMessage()
panva Feb 3, 2021
aebe532
doc: consistent webcrypto `node.keyObject` format
panva Feb 3, 2021
760f126
doc: mark Certificate methods as static, add missing KeyObject.from
panva Feb 3, 2021
3e2746f
crypto: remove webcrypto "DSA" JWK Key Type operations
panva Feb 3, 2021
48a634e
test: rename n-api to node-api
Feb 3, 2021
c302450
fs: allow passing negative zero fd
RaisinTen Jan 29, 2021
3fee5b2
repl: add auto‑completion for dynamic import calls
ExE-Boss Feb 2, 2021
dc38dd2
timers: fix unsafe array iteration
RaisinTen Feb 4, 2021
9dac99a
crypto: fix and simplify prime option validation
tniessen Feb 1, 2021
acabe08
lib: add weak event handlers
benjamingr Feb 4, 2021
354df9e
src: use make_shared for safe allocation
yashLadha Jan 30, 2021
a6053dc
src: add context for TODO comment in env.cc
yashLadha Jan 30, 2021
20c65b0
deps: V8: backport dfcf1e86fac0
targos Feb 7, 2021
eb0daae
tools: fix d8 macOS build
targos Feb 3, 2021
3079a78
src: avoid implicit type conversions
targos Jan 30, 2021
54d36b0
src: rename binding_data_name to type_name in BindingData
joyeecheung Jan 28, 2021
1a9bcdf
src: refactor v8 binding
joyeecheung Jan 28, 2021
d8d851a
tools: bump remark-present-lint-node from 2.0.0 to 2.0.1
Trott Feb 8, 2021
ebf3597
doc: rename N-API to Node-API
Feb 7, 2021
7c51cec
util: use assert for unreachable code
Trott Feb 6, 2021
7da1c9b
doc: use sentence case for headers in BUILDING.md
Trott Feb 6, 2021
47c4f1f
doc: use sentence case in README headers
Trott Feb 6, 2021
0e887ca
doc: fix typo in console.md
marsonya Feb 8, 2021
5a4288e
doc: fix typo in crypto.md
marsonya Feb 8, 2021
cd50e93
doc: warn about using strings as inputs in crypto
tniessen Feb 6, 2021
a693baa
module: use optional chaining in cjs/loader.js
RaisinTen Feb 5, 2021
55fd6b6
crypto: avoid infinite loops in prime generation
tniessen Feb 3, 2021
8483de4
test: only run prime test with supported OpenSSL
tniessen Feb 5, 2021
f6f9af6
lib: fix WebIDL `object` and dictionary type conversion
ExE-Boss Jan 24, 2021
6db5e79
tools: add GitHub Action linter for pr-url
aduh95 Feb 4, 2021
d1c1724
deps: upgrade npm to 7.5.3
ruyadorno Feb 8, 2021
85bed2e
doc: fix misnamed SHASUMS256.txt name in README.md
marsonya Feb 7, 2021
e28ea89
crypto: fix subtle.importKey JWK OKP public key import
panva Feb 6, 2021
42cc33c
src: add mutex to ManagedEVPPKey class
danbev Jan 7, 2021
061939d
node-api: allow retrieval of add-on file name
Feb 3, 2021
d63ac28
http: explain the unused argument in IncomingMessage._read
Ayase-252 Feb 8, 2021
f5d1bf9
http: explain the possibilty of refactor unused argument
Ayase-252 Feb 10, 2021
e28fa6c
src: fix return type of method in string_search.h
RaisinTen Feb 1, 2021
3464c9f
doc: discourage error event
benjamingr Feb 7, 2021
50e81ba
deps: V8: cherry-pick 0c8b6e415c30
matinzd Feb 8, 2021
facf3a5
doc: fix description of hasSubscribers
tniessen Feb 11, 2021
7d8fd3f
doc: refactor fs docs structure
jasnell Feb 1, 2021
d96a97a
module: make synthetic module evaluation steps return a Promise to su…
dandclark Feb 9, 2021
1ff375b
tools: avoid pending deprecation in doc generator
targos Feb 7, 2021
8487184
child_process: fix bad abort signal leak
Feb 6, 2021
15804e0
errors: align source-map stacks with spec
Feb 6, 2021
1fc8307
test: re-implement promises.setInterval() test robustly
Trott Feb 4, 2021
d0f1ff5
async_hooks: set unhandledRejection async context
Feb 7, 2021
fbcab10
url: move `URLSearchParams` method definitions
ExE-Boss Jan 6, 2021
676f696
url: fix definitions of `URL`/`SearchParams` methods and accessors
ExE-Boss Jan 5, 2021
a483c28
tools: fix lint-pr-url message
aduh95 Feb 10, 2021
cdd2fe5
doc: fix typo in /api/dns.md
marsonya Feb 10, 2021
804e7ae
doc: add version metadata for packages features
aduh95 Feb 9, 2021
f253cb9
doc: fix typo in buffer.md
marsonya Feb 7, 2021
85b1476
doc: fix typo in deprecations.md
marsonya Feb 8, 2021
c4faa39
perf_hooks: introduce createHistogram
jasnell Jan 30, 2021
610b29b
doc: fix performanceEntry.flags style format
chengcyber Feb 8, 2021
189ce39
doc: apply sentence case to release doc headers
Trott Feb 13, 2021
62b2648
doc: apply sentence-consistently in C++ style guide
Trott Feb 13, 2021
392c86d
doc: use sentence case in benchmark doc
Trott Feb 13, 2021
1e99175
doc: alphabetize crypto.* methods
Trott Feb 13, 2021
3db1b30
meta: update README releases section
Feb 11, 2021
e2a2bab
doc: link PACKAGE_EXPORTS_RESOLVE to ESM section
ugultopu Jan 30, 2021
f5e4625
doc: fix backticks in crypto API docs
tniessen Feb 8, 2021
c188466
doc: fix quotes in stream docs
tniessen Feb 8, 2021
dd054ca
doc: optimize HTML rendering
aduh95 Feb 9, 2021
c160d88
buffer: add @@toStringTag to Blob
cjihrig Feb 12, 2021
b2b6411
tools: update ESLint to 7.20.0
cjihrig Feb 12, 2021
88d3f74
fs: add fsPromises.watch()
jasnell Feb 1, 2021
799b2d5
policy: fix cascade getting scope
bmeck Feb 9, 2021
6d53e79
repl: refactor to avoid unsafe array iteration
aduh95 Feb 12, 2021
05a16e7
worker: refactor to avoid unsafe array iteration
aduh95 Feb 12, 2021
c0eadef
deps: upgrade to libuv 1.41.0
cjihrig Feb 13, 2021
b09d21b
test: enable no-restricted-syntax rule for test-timers-promisified
Trott Feb 13, 2021
d808db2
doc: add dmabupt to collaborators
dmabupt Feb 15, 2021
c6198fd
lib: simplify check in child_process
RaisinTen Feb 14, 2021
2e1f1c6
tools: refactor prefer-primordials
aduh95 Nov 7, 2020
b5692b4
test: fix test-doctool-html
aduh95 Feb 16, 2021
5133659
2021-02-16, Version 15.9.0 (Current)
danielleadams Feb 16, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: apply sentence case to release doc headers
Our style is to use sentence case for headers and documentation titles.
The documentation for releases uses both sentence case and title case.
This change applies sentence case consistently throughout.

PR-URL: #37349
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
Trott authored and danielleadams committed Feb 16, 2021
commit 189ce399da16d9a40e5a21ca03086eeaa899601a
82 changes: 41 additions & 41 deletions doc/guides/releases.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,48 @@
# Node.js Release Process
# Node.js release process

This document describes the technical aspects of the Node.js release process.
The intended audience is those who have been authorized by the Node.js
Technical Steering Committee (TSC) to create, promote, and sign
official release builds for Node.js, hosted on <https://nodejs.org/>.

## Table of Contents
## Table of contents

* [Who can make a release?](#who-can-make-a-release)
* [1. Jenkins Release Access](#1-jenkins-release-access)
* [2. <nodejs.org> Access](#2-nodejsorg-access)
* [3. A Publicly Listed GPG Key](#3-a-publicly-listed-gpg-key)
* [1. Jenkins release access](#1-jenkins-release-access)
* [2. <nodejs.org> access](#2-nodejsorg-access)
* [3. A publicly listed GPG key](#3-a-publicly-listed-gpg-key)
* [How to create a release](#how-to-create-a-release)
* [0. Pre-release steps](#0-pre-release-steps)
* [1. Update the staging branch](#1-update-the-staging-branch)
* [2. Create a new branch for the release](#2-create-a-new-branch-for-the-release)
* [3. Update `src/node_version.h`](#3-update-srcnode_versionh)
* [4. Update the Changelog](#4-update-the-changelog)
* [5. Create Release Commit](#5-create-release-commit)
* [6. Propose Release on GitHub](#6-propose-release-on-github)
* [7. Ensure that the Release Branch is Stable](#7-ensure-that-the-release-branch-is-stable)
* [8. Produce a Nightly Build _(optional)_](#8-produce-a-nightly-build-optional)
* [9. Produce Release Builds](#9-produce-release-builds)
* [10. Test the Build](#10-test-the-build)
* [11. Tag and Sign the Release Commit](#11-tag-and-sign-the-release-commit)
* [12. Set Up For the Next Release](#12-set-up-for-the-next-release)
* [13. Cherry-pick the Release Commit to `master`](#13-cherry-pick-the-release-commit-to-master)
* [4. Update the changelog](#4-update-the-changelog)
* [5. Create release commit](#5-create-release-commit)
* [6. Propose release on GitHub](#6-propose-release-on-github)
* [7. Ensure that the release branch is stable](#7-ensure-that-the-release-branch-is-stable)
* [8. Produce a nightly build _(optional)_](#8-produce-a-nightly-build-optional)
* [9. Produce release builds](#9-produce-release-builds)
* [10. Test the build](#10-test-the-build)
* [11. Tag and sign the release commit](#11-tag-and-sign-the-release-commit)
* [12. Set up for the next release](#12-set-up-for-the-next-release)
* [13. Cherry-pick the release commit to `master`](#13-cherry-pick-the-release-commit-to-master)
* [14. Push the release tag](#14-push-the-release-tag)
* [15. Promote and Sign the Release Builds](#15-promote-and-sign-the-release-builds)
* [16. Check the Release](#16-check-the-release)
* [17. Create a Blog Post](#17-create-a-blog-post)
* [15. Promote and sign the release builds](#15-promote-and-sign-the-release-builds)
* [16. Check the release](#16-check-the-release)
* [17. Create a blog post](#17-create-a-blog-post)
* [18. Create the release on GitHub](#18-create-the-release-on-github)
* [19. Cleanup](#19-cleanup)
* [20. Announce](#20-announce)
* [21. Celebrate](#21-celebrate)
* [LTS Releases](#lts-releases)
* [Major Releases](#major-releases)
* [LTS releases](#lts-releases)
* [Major releases](#major-releases)

## Who can make a release?

Release authorization is given by the Node.js TSC. Once authorized, an
individual must have the following:

### 1. Jenkins Release Access
### 1. Jenkins release access

There are three relevant Jenkins jobs that should be used for a release flow:

Expand All @@ -64,7 +64,7 @@ a manual step once they are ready (see below).
The [Node.js build team](https://github.com/nodejs/build) is able to provide
this access to individuals authorized by the TSC.

### 2. <nodejs.org> Access
### 2. <nodejs.org> access

The _dist_ user on nodejs.org controls the assets available in
<https://nodejs.org/download/>. <https://nodejs.org/dist/> is an alias for
Expand All @@ -82,7 +82,7 @@ server as the _dist_ user. The
[Node.js build team](https://github.com/nodejs/build) is able to provide this
access to individuals authorized by the TSC.

### 3. A Publicly Listed GPG Key
### 3. A publicly-listed GPG key

A `SHASUMS256.txt` file is produced for every promoted build, nightly, and
releases. Additionally for releases, this file is signed by the individual
Expand Down Expand Up @@ -258,7 +258,7 @@ It is current TSC policy to bump major version when ABI changes. If you
see a need to bump `NODE_MODULE_VERSION` then you should consult the TSC.
Commits may need to be reverted or a major version bump may need to happen.

### 4. Update the Changelog
### 4. Update the changelog

#### Step 1: Collect the formatted list of changes

Expand Down Expand Up @@ -344,7 +344,7 @@ must be assigned a number (e.g. `DEP0012`). This assignment should
occur when the PR is landed, but a check will be made when the release build is
run.

### 5. Create Release Commit
### 5. Create release commit

The `CHANGELOG.md`, `doc/changelogs/CHANGELOG_Vx.md`, `src/node_version.h`, and
`REPLACEME` changes should be the final commit that will be tagged for the
Expand Down Expand Up @@ -373,7 +373,7 @@ Notable changes:
* Copy the notable changes list here, reformatted for plain-text
```

### 6. Propose Release on GitHub
### 6. Propose release on GitHub

Push the release branch to `nodejs/node`, not to your own fork. This allows
release branches to more easily be passed between members of the release team if
Expand All @@ -391,7 +391,7 @@ good place to @-mention the relevant contributors.
After opening the PR, update the release commit to include `PR-URL` metadata and
force-push the proposal.

### 7. Ensure that the Release Branch is Stable
### 7. Ensure that the release branch is stable

Run a **[`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)**
test run to ensure that the build is stable and the HEAD commit is ready for
Expand All @@ -406,7 +406,7 @@ purpose. Run it once with the base `vx.x` branch as a reference and with the
proposal branch to check if new regressions could be introduced in the
ecosystem.

### 8. Produce a Nightly Build _(optional)_
### 8. Produce a nightly build _(optional)_

If there is a reason to produce a test release for the purpose of having others
try out installers or specifics of builds, produce a nightly build using
Expand All @@ -418,7 +418,7 @@ enter a proper length commit SHA, enter a date string, and select "nightly" for
This is particularly recommended if there has been recent work relating to the
macOS or Windows installers as they are not tested in any way by CI.

### 9. Produce Release Builds
### 9. Produce release builds

Use **[iojs+release](https://ci-release.nodejs.org/job/iojs+release/)** to
produce release artifacts. Enter the commit that you want to build from and
Expand Down Expand Up @@ -464,14 +464,14 @@ can use the
build in the release CI to re-run the build only for ARMv6. When launching the
build make sure to use the same commit hash as for the original release.

### 10. Test the Build
### 10. Test the build

Jenkins collects the artifacts from the builds, allowing you to download and
install the new build. Make sure that the build appears correct. Check the
version numbers, and perform some basic checks to confirm that all is well with
the build before moving forward.

### 11. Tag and Sign the Release Commit
### 11. Tag and sign the release commit

Once you have produced builds that you're happy with, create a new tag. By
waiting until this stage to create tags, you can discard a proposed release if
Expand Down Expand Up @@ -506,7 +506,7 @@ $ git secure-tag <vx.y.z> <commit-sha> -sm "YYYY-MM-DD Node.js vx.y.z (<release-
The tag **must** be signed using the GPG key that's listed for you on the
project README.

### 12. Set Up For the Next Release
### 12. Set up for the next release

On release proposal branch, edit `src/node_version.h` again and:

Expand Down Expand Up @@ -536,7 +536,7 @@ $ git rebase v1.x
$ git push upstream v1.x-staging
```

### 13. Cherry-pick the Release Commit to `master`
### 13. Cherry-pick the release commit to `master`

```console
$ git checkout master
Expand Down Expand Up @@ -579,7 +579,7 @@ $ git push <remote> <vx.y.z>
*Note*: Please do not push the tag unless you are ready to complete the
remainder of the release steps.

### 15. Promote and Sign the Release Builds
### 15. Promote and sign the release builds

**The same individual who signed the release tag must be the one
to promote the builds as the `SHASUMS256.txt` file needs to be signed with the
Expand Down Expand Up @@ -655,7 +655,7 @@ be prompted to re-sign `SHASUMS256.txt`.
**It is possible to only sign a release by running `./tools/release.sh -s
vX.Y.Z`.**

### 16. Check the Release
### 16. Check the release

Your release should be available at `https://nodejs.org/dist/vx.y.z/` and
<https://nodejs.org/dist/latest/>. Check that the appropriate files are in
Expand All @@ -664,7 +664,7 @@ have the right internal version strings. Check that the API docs are available
at <https://nodejs.org/api/>. Check that the release catalog files are correct
at <https://nodejs.org/dist/index.tab> and <https://nodejs.org/dist/index.json>.

### 17. Create a Blog Post
### 17. Create a blog post

There is an automatic build that is kicked off when you promote new builds, so
within a few minutes nodejs.org will be listing your new version as the latest
Expand Down Expand Up @@ -732,7 +732,7 @@ _In whatever form you do this..._

## LTS Releases

### Marking a Release Line as LTS
### Marking a release line as LTS

To mark a release line as LTS, the following changes must be made to
`src/node_version.h`:
Expand Down Expand Up @@ -770,7 +770,7 @@ existing labels for that release line, such as `vN.x`.
If the release is transitioning from Active LTS to Maintenance, the
`backport-requested-vN.x` label must be deleted.

## Major Releases
## Major releases

The process for cutting a new Node.js major release has a number of differences
from cutting a minor or patch release.
Expand All @@ -791,7 +791,7 @@ The release date for the next major release should be announced immediately
following the current release (e.g. the release date for 13.0.0 should be
announced immediately following the release of 12.0.0).

### Release Branch
### Release branch

Approximately three months before a major release, new `vN.x` and
`vN.x-staging` branches (where `N` indicates the major release) should be
Expand Down Expand Up @@ -821,7 +821,7 @@ The label description can be copied from existing labels of previous releases.
The label color must be the same for all new labels, but different from the
labels of previous releases.

### Release Proposal
### Release proposal

A draft release proposal should be created two months before the release. A
separate `vN.x-proposal` branch should be created that tracks the `vN.x`
Expand All @@ -832,7 +832,7 @@ Notify the `@nodejs/npm` team in the release proposal PR to inform them of the
upcoming release. `npm` maintains a list of [supported versions](https://github.com/npm/cli/blob/latest/lib/utils/unsupported.js#L3)
that will need updating to include the new major release.

### Test Releases and Release Candidates
### Test releases and release candidates

Test builds should be generated from the `vN.x-proposal` branch starting at
about 6 weeks before the release.
Expand Down