Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: update v14 and v12 changelogs in v15.x release line #37767

Closed
wants to merge 40 commits into from
Closed

doc: update v14 and v12 changelogs in v15.x release line #37767

wants to merge 40 commits into from

Conversation

danielleadams
Copy link
Contributor

@danielleadams danielleadams commented Mar 16, 2021 •
edited
Loading

There were a few commits that were landed in v15.x that are referencing more recent versions of the LTS versions (v14.x and v12.x). While the tests/linting passed locally, the PR linting fails because it detects missing CHANGELOG references in the API docs: https://github.com/nodejs/node/pull/37766/checks?check_run_id=2122554570

This updates the changelogs for both LTS versions so that the Current versions will have the correct references. (Ref: #37766)

gabrielschulhof and others added 30 commits March 16, 2021 08:56
@gabrielschulhof @danielleadams
node-api: define version 8
f93d03d 
Mark as stable the APIs that define Node-API version 8.

PR-URL: nodejs#37652
Reviewed-By: Gerhard Stöbich <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
@panva @danielleadams
crypto: add optional callback to crypto.sign and crypto.verify
5ff4959 
PR-URL: nodejs#37500
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
@cjihrig @danielleadams
deps: V8: cherry-pick 1648e050cade
1c62f2d 
Original commit message:

    torque: workaround stod() limitations on Solaris

    std::stod() on Solaris does not currently handle hex strings.
    This commit provides a workaround based on strtol() until proper
    stod() support is available.

    This was encountered while updating Node.js to V8 8.8. For more
    details see the following comment:

    nodejs#36139 (comment)

    Change-Id: I16ed80a817f6d9105e7153b10824b1fee8520432
    Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/2692746
    Reviewed-by: Michael Stanton <[email protected]>
    Commit-Queue: Michael Stanton <[email protected]>
    Cr-Commit-Position: refs/heads/master@{#73255}

Refs: v8/v8@1648e05
PR-URL: nodejs#37664
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@panva @danielleadams
test: fixup flaky test-crypto-x509
7fd2a69 
PR-URL: nodejs#37709
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
@jasnell @danielleadams
doc: crypto esm examples
7530873 
Signed-off-by: James M Snell <[email protected]>

PR-URL: nodejs#37594
Refs: nodejs#37162
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Filip Skokan <[email protected]>
@tniessen @danielleadams
src: fix variable name of OnCloseReceived callback
4f892af 
PR-URL: nodejs#37521
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
@marsonya @danielleadams
doc: use sentence case in README.md headers
4233d6c 
PR-URL: nodejs#37645
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Zijian Liu <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
@RaisinTen @danielleadams
crypto: add internal error codes
6ef1d33 
PR-URL: nodejs#37650
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@aduh95 @danielleadams
module: refactor NativeModule to avoid unsafe array iteration
bb1967c 
PR-URL: nodejs#37656
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Zijian Liu <[email protected]>
@tniessen @danielleadams
doc: fix typo in description of close event
71150ee 
PR-URL: nodejs#37662
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@lpinca @danielleadams
stream,util: fix "the the" typo in comments
756328a 
PR-URL: nodejs#37674
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
@marsonya @danielleadams
lib: fix typo in lib/internal/http2/core.js
5d12de3 
PR-URL: nodejs#37695
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
@tniessen @danielleadams
doc: fix link to googletest fixtures
ce0350d 
PR-URL: nodejs#37698
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Harshitha K P <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
@jasnell @danielleadams
crypto: reconcile duplicated code
28e827f 
Signed-off-by: James M Snell <[email protected]>

PR-URL: nodejs#37704
Reviewed-By: Filip Skokan <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
@aduh95 @danielleadams
test,crypto: ensure promises resolve in webcrypto tests
2577f10 
PR-URL: nodejs#37653
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@aduh95 @danielleadams
http: refactor to avoid unsafe array iteration
77c5c2f 
PR-URL: nodejs#37654
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Zijian Liu <[email protected]>
@aduh95 @danielleadams
tls: refactor to avoid unsafe array iteration
311ddc9 
PR-URL: nodejs#37655
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Zijian Liu <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@Linkgoron @danielleadams
fs: improve fsPromises writeFile performance
e556215 
Increase the write chunk size in fsPromises writeFile
to improve performance.

PR-URL: nodejs#37610
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
@Linkgoron @danielleadams
benchmark: add benchmark for fsPromises.writeFile
ea10155 
added fs.promises.writeFile benchmark

PR-URL: nodejs#37610
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
@BridgeAR @danielleadams
assert,util: fix commutativity edge case
ce8ac4d 
Verify that both objects property keys are enumerable.

Fixes: nodejs#37710

PR-URL: nodejs#37711
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@ruyadorno @danielleadams
deps: upgrade npm to 7.6.3
efd14a9 
PR-URL: nodejs#37721
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
@jasnell @danielleadams
events: remove return value on addEventListener
3acba1d 
The `addEventListener()` should not return a value.

Signed-off-by: James M Snell <[email protected]>

PR-URL: nodejs#37696
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Gerhard Stöbich <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
@cjihrig @danielleadams
http2: make res.req a normal property
e4667eb 
The change in nodejs#36505 broke
userland code that already wrote to res.req. This commit updates
the res.req property in the http2 compat layer to be a normal
property.

PR-URL: nodejs#37706
Fixes: nodejs#37705
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Robert Nagy <[email protected]>
Reviewed-By: Mary Marchini <[email protected]>
Reviewed-By: Gerhard Stöbich <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
@jasnell @danielleadams
lib: use AbortError consistently
8c084d9 
Signed-off-by: James M Snell <[email protected]>

PR-URL: nodejs#37715
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@jasnell @danielleadams
doc: recommend checking abortSignal.aborted first
0563260 
Signed-off-by: James M Snell <[email protected]>

PR-URL: nodejs#37714
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@addaleax @danielleadams
util: inspect __proto__ key as written in object literal
8fdc4a5 
Since util.inspect() gives object-literal-like output, handle the
special `__proto__` key in the way that it would be handled in object
literals.

PR-URL: nodejs#37713
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Gus Caplan <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Gerhard Stöbich <[email protected]>
@Trott @danielleadams
test: address flaky wpt/test-timers
e6e2112 
Moving test harness from Parallel to Simple resolves most of the
failures. negative-settimeout.any.js still needs to be marked flaky.

Refs: nodejs#37672

PR-URL: nodejs#37691
Fixes: nodejs#37672
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
@jasnell @danielleadams
deps: switch openssl to quictls/openssl
8d0af3e 
As of
quictls/openssl@0c70d48

Source: https://github.com/quictls/openssl/tree/OpenSSL_1_1_1j+quic
Signed-off-by: James M Snell <[email protected]>

PR-URL: nodejs#37601
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Gus Caplan <[email protected]>
Reviewed-By: Daniel Bevenius <[email protected]>
Reviewed-By: Jiawen Geng <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
@jasnell @danielleadams
deps: update archs files for OpenSSL-1.1.1+quic
53b9805 
Signed-off-by: James M Snell <[email protected]>

PR-URL: nodejs#37601
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Gus Caplan <[email protected]>
Reviewed-By: Daniel Bevenius <[email protected]>
Reviewed-By: Jiawen Geng <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
@jasnell @danielleadams
test: fixup test to account for quic openssl version
345af4d 
PR-URL: nodejs#37601
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Gus Caplan <[email protected]>
Reviewed-By: Daniel Bevenius <[email protected]>
Reviewed-By: Jiawen Geng <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
jasnell and others added 10 commits March 16, 2021 08:57
@jasnell @danielleadams
doc: update maintaining-openssl guide
faffb61 
PR-URL: nodejs#37601
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Gus Caplan <[email protected]>
Reviewed-By: Daniel Bevenius <[email protected]>
Reviewed-By: Jiawen Geng <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
@jasnell @danielleadams
worker: add setEnvironmentData/getEnvironmentData
b62c08b 
These APIs allow arbitrary, cloneable JavaScript values to be set and
passed to all new Worker instances spawned from the current context.
It is similar to `workerData` except that environment data is set
independently of the `new Worker()` constructor, and the the value is
passed automatically to all new Workers.

This is a *partial* fix of nodejs#30992
but does not implement a complete fix.

Signed-off-by: James M Snell <[email protected]>

PR-URL: nodejs#37486
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
@jasnell @danielleadams
lib: implement AbortSignal.abort()
a4e9edb 
Refs: whatwg/dom#960

PR-URL: nodejs#37693
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
@jasnell @danielleadams
test: update dom/abort tests
ba5a0d9 
Signed-off-by: James M Snell <[email protected]>

PR-URL: nodejs#37693
Refs: whatwg/dom#960
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
@lpinca @danielleadams
doc: add hints to http.request() options
fb46d03 
PR-URL: nodejs#37745
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Gerhard Stöbich <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
@bcoe @danielleadams
errors: remove experimental from --enable-source-maps
35b0395 
PR-URL: nodejs#37743
Reviewed-By: Gerhard Stöbich <[email protected]>
Reviewed-By: Ruy Adorno <[email protected]>
Reviewed-By: Ian Sutherland <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@ruyadorno @danielleadams
tools: use bundled npm in update scripts
dba24b3 
The scripts `./tools/update-babel-eslint.sh` and
`./tools/update-eslint.sh` are relying on the version of `npm` found in
the local-defined `$PATH` env.

This changeset proposes to modify these scripts to run the version of
npm bundled in the current branch (found at `./deps/npm`) - in order to:

a) Standardize the version of npm that should be use to install these
deps, avoids the pitfall of having an inadverted user run these
scripts with an unsupported/incompatible npm version.
b) Given that npm7 has a different install algorithm than npm6 that
takes into account and install peer dependencies, it might be a safer
choice to ensure what version of npm should be use during this
transitional period in which users might still have npm6 by default in
their local system.
c) Avoids the possible extra churn of having different resulting files
being shuffled around between installs due to usage of a disparate
version of the npm cli.

PR-URL: nodejs#37613
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
@danbev @danielleadams
src,test: support dynamically linking OpenSSL 3.0
bcbdcfc 
This commit enables node to dynamically link against OpenSSL 3.0.

The motivation for opening this PR even though OpenSSL 3.0 has not been
released yet is to allow a nightly CI job to be created. This will
allow us stay on top of changes required for OpenSSL 3.0, and also to
make sure that changes to node crypto do not cause issues when linking
to OpenSSL 3.0.

PR-URL: nodejs#37669
Refs: nodejs#29817
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
@marsonya @danielleadams
doc: add marsonya as a triager
9fad821 
I would like to apply for the role of a triager
in this project. My motivation to become a triager
is to help manage issues, as well as learn deeper
concepts of Node.js, and eventually become a
collaborator! I hereby declare that I have read and
understood the Code of Conduct and will adhere to that.

PR-URL: nodejs#37667
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Pooja D P <[email protected]>
@danielleadams
doc: update v14 and v12 changelogs
8a94870
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. v15.x labels Mar 16, 2021
@richardlau
Copy link
Member

hmm cc @nodejs/releasers
I'm not going to block this as I don't want to hold up the 15.12.0 release, but we currently have no policy/procedure for keeping the earlier semver major changelogs up to date in the current release line (which is why they're missing in the first place) so there's a strong possibility of this reoccurring in future.

@danielleadams
Copy link
Contributor Author

@richardlau I'm going to open a bug report about this and then add it to the next releasers meeting agenda. Most likely, we will probably need a step in the release process that either adds current LTS changelog changes or adding the release changes to all release lines. We can discuss

@aduh95
Copy link
Contributor

aduh95 commented Mar 16, 2021

@richardlau Agreed, I'm working on adding a condition to skip the test on pull request targeting a branch other than master.

@danielleadams danielleadams added the fast-track PRs that do not need to wait for 48 hours to land. label Mar 16, 2021
@targos
Copy link
Member

targos commented Mar 16, 2021

My question is: how did the added: lines end up in v15.x-staging? They are supposed to be updated in release commits and we do not cherry-pick any release commit from master to releases branches, so v15.x documentation should never get new "added" lines for new releases of other versions.

aduh95 added a commit to aduh95/node that referenced this pull request Mar 16, 2021
@aduh95
tools: lint version numbers in doc only in the default branch
e2f9304 
Changelogs are sometimes not backported to release branches; this check
is useful on the `master` branch, not so much in the other branches.

Refs: nodejs#37767
@aduh95 aduh95 mentioned this pull request Mar 16, 2021
Merged
@richardlau
Copy link
Member

My question is: how did the added: lines end up in v15.x-staging? They are supposed to be updated in release commits and we do not cherry-pick any release commit from master to releases branches, so v15.x documentation should never get new "added" lines for new releases of other versions.

At least some of them have come from 7d8fd3f.

@danielleadams
Copy link
Contributor Author

danielleadams commented Mar 16, 2021 •
edited
Loading

Looks like here too: #37652

@aduh95
Copy link
Contributor

aduh95 commented Mar 16, 2021

Alternatively to backporting the changelogs, we can fast-track #37768 and include it in the v15.12.0 release.

@danielleadams
Copy link
Contributor Author

@aduh95 I would prefer that, thanks

@danielleadams
Copy link
Contributor Author

closed in favor of #37768

aduh95 added a commit to aduh95/node that referenced this pull request Mar 16, 2021
@aduh95
tools: parse changelogs only in the default branch
901ef1b 
The `lint-md` job on GitHub Actions parses the changelogs to determine
if the version numbers referenced in the YAML comments in the docs match
actual releases of Node.js.
Changelogs are sometimes not backported to release branches; this commit
disables changelog parsing on branches other than the default one.

Refs: nodejs#37767

PR-URL: nodejs#37768
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Danielle Adams <[email protected]>
Reviewed-By: Ruy Adorno <[email protected]>
danielleadams pushed a commit that referenced this pull request Mar 17, 2021
@aduh95 @danielleadams
tools: parse changelogs only in the default branch
72af5d9 
The `lint-md` job on GitHub Actions parses the changelogs to determine
if the version numbers referenced in the YAML comments in the docs match
actual releases of Node.js.
Changelogs are sometimes not backported to release branches; this commit
disables changelog parsing on branches other than the default one.

Refs: #37767

PR-URL: #37768
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Danielle Adams <[email protected]>
Reviewed-By: Ruy Adorno <[email protected]>
@danielleadams danielleadams deleted the add-14.x-and-12.x-changelogs branch March 17, 2021 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aduh95 aduh95 aduh95 approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.