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.

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: deprecate finished #28679

Closed
wants to merge 12 commits into from
Closed

doc: deprecate finished #28679

wants to merge 12 commits into from

Conversation

ronag
Copy link
Member

@ronag ronag commented Jul 14, 2019

Remove finished from docs. The naming and function is very confusing and misleading. What is finished is actually ended in the streams spec.

Refs: #28651

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added the http Issues or PRs related to the http subsystem. label Jul 14, 2019
@ronag ronag force-pushed the deprecate-finished branch 4 times, most recently from 11a9c1a to 46e9301 Compare July 14, 2019 12:43
benjamingr
benjamingr reviewed Jul 14, 2019
View reviewed changes
Copy link
Member

@benjamingr benjamingr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be docs-deprecated rather than removed from the docs altogether IMO

@ronag ronag changed the title http: deprecate finished doc: deprecate finished Jul 14, 2019
@ronag
Copy link
Member Author

ronag commented Jul 14, 2019 •
edited

Not quite sure how to docs-deprecate... but I tried... feedback welcome

@benjamingr
Copy link
Member

Does anyone have a strong opinion regarding how we should deprecate this? @mcollina maybe?

(no hurry)

@addaleax
Copy link
Member

Does anyone have a strong opinion regarding how we should deprecate this?

I agree that documentation-only deprecating makes the most sense here.

@ronag ronag force-pushed the deprecate-finished branch 2 times, most recently from a97f9fc to cd143ec Compare July 14, 2019 21:19
@Trott Trott added the notable-change PRs with changes that should be highlighted in changelogs. label Jul 15, 2019
ChALkeR
ChALkeR previously requested changes Jul 31, 2019
View reviewed changes
doc/api/deprecations.md Outdated Show resolved Hide resolved
doc/api/http.md Outdated Show resolved Hide resolved
doc/api/http.md Outdated Show resolved Hide resolved
doc/api/http2.md Outdated Show resolved Hide resolved
@ronag
Copy link
Member Author

ronag commented Aug 2, 2019

Blocked by #28934. Let's see what happens there first. It's relevant to the deprecation description.

@ronag ronag mentioned this pull request Aug 5, 2019
Closed
4 tasks
@ronag
Copy link
Member Author

ronag commented Aug 5, 2019

fixed @ChALkeR

@ronag
Copy link
Member Author

ronag commented Aug 5, 2019

@Trott blocked by #28934

This was referenced Aug 6, 2019
Closed
Closed
@Trott Trott added the blocked PRs that are blocked by other issues or PRs. label Aug 6, 2019
@jasnell jasnell added deprecations Issues and PRs related to deprecations. semver-major PRs that contain breaking changes and should be released in the next major version. labels Aug 7, 2019
@ronag ronag force-pushed the deprecate-finished branch 3 times, most recently from aea31b3 to 9a0472a Compare August 17, 2019 07:42
@ronag
Copy link
Member Author

ronag commented Aug 17, 2019

@Trott: this is no longer blocked, ping node/http?

@ronag
Copy link
Member Author

ronag commented Nov 20, 2019

@Trott: The doc linting error seems unrelated to this PR. Not sure what's going on there.

Trott
Trott reviewed Nov 20, 2019
View reviewed changes
doc/api/deprecations.md Outdated Show resolved Hide resolved
ronag and others added 2 commits November 20, 2019 22:44
@ronag @Trott
Update doc/api/deprecations.md
11337b6 
Co-Authored-By: Rich Trott <rtrott@gmail.com>
@ronag
fixup: ref
dcd3724
@ronag
Copy link
Member Author

ronag commented Nov 20, 2019 •
edited

@Trott: Linting pass

@lundibundi
Copy link
Member

Lite-CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/4082/

Trott
Trott reviewed Dec 7, 2019
View reviewed changes
doc/api/deprecations.md Outdated Show resolved Hide resolved
ronag
ronag commented Dec 7, 2019
View reviewed changes
doc/api/deprecations.md Outdated Show resolved Hide resolved
BridgeAR
BridgeAR reviewed Dec 9, 2019
View reviewed changes
doc/api/deprecations.md Outdated Show resolved Hide resolved
@ronag @BridgeAR
Update doc/api/deprecations.md
60c6119 
Co-Authored-By: Ruben Bridgewater <ruben@bridgewater.de>
@BridgeAR
Copy link
Member

Lite-CI https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/4102/

BridgeAR pushed a commit that referenced this pull request Dec 10, 2019
@ronag @BridgeAR
doc: deprecate http finished
c6ab3af 
PR-URL: #28679
Refs: #28651
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@BridgeAR
Copy link
Member

Landed in c6ab3af 🎉

@BridgeAR BridgeAR closed this Dec 10, 2019
targos pushed a commit that referenced this pull request Dec 10, 2019
@ronag @targos
doc: deprecate http finished
93ca4f4 
PR-URL: #28679
Refs: #28651
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@MylesBorins MylesBorins mentioned this pull request Dec 13, 2019
Merged
MylesBorins added a commit that referenced this pull request Dec 16, 2019
@MylesBorins
2019-12-17, Version 13.4.0 (Current)
57bf5b7 
This is a security release.

This release includes a single commit, an update to npm to 6.13.4.

For more details about the vulnerability please consult the npm blog:

https://blog.npmjs.org/post/189618601100/binary-planting-with-the-npm-cli

Notable Changes:
* deps:
  - update npm to 6.13.4
    #30904
  - update uvwasi (Anna Henningsen)
    #30745
  - upgrade to libuv 1.34.0 (Colin Ihrig)
    #30783
* doc:
  - docs deprecate http finished (Robert Nagy)
    #28679
* events:
  - add captureRejection option (Matteo Collina)
    #27867
* http:
  - add captureRejection support (Matteo Collina)
    #27867
  - llhttp opt-in insecure HTTP header parsing (Sam Roberts)
    #30567
* http2:
  - implement capture rection for 'request' and 'stream' events (Matteo Collina)
    #27867
* net:
  - implement capture rejections for 'connection' event (Matteo Collina)
    #27867
* repl:
  - support previews by eager evaluating input (Ruben Bridgewater)
    #30811
* stream:
  - add support for captureRejection option (Matteo Collina)
    #27867
* tls:
  - implement capture rejections for 'secureConnection' event (Matteo Collina)
    #27867
  - expose IETF name for current cipher suite (Sam Roberts)
    #30637
* worker:
  - add argv constructor option (legendecas)
    #30559

PR-URL: #30937
MylesBorins added a commit that referenced this pull request Dec 16, 2019
@MylesBorins
2019-12-17, Version 13.4.0 (Current)
906a1fd 
This is a security release.

This release includes a single commit, an update to npm to 6.13.4.

For more details about the vulnerability please consult the npm blog:

https://blog.npmjs.org/post/189618601100/binary-planting-with-the-npm-cli

Notable Changes:
* deps:
  * update npm to 6.13.4
    #30904
  * update uvwasi (Anna Henningsen)
    #30745
  * upgrade to libuv 1.34.0 (Colin Ihrig)
    #30783
* doc:
  * docs deprecate http finished (Robert Nagy)
    #28679
* events:
  * add captureRejection option (Matteo Collina)
    #27867
* http:
  * add captureRejection support (Matteo Collina)
    #27867
  * llhttp opt-in insecure HTTP header parsing (Sam Roberts)
    #30567
* http2:
  * implement capture rection for 'request' and 'stream' events (Matteo Collina)
    #27867
* net:
  * implement capture rejections for 'connection' event (Matteo Collina)
    #27867
* repl:
  * support previews by eager evaluating input (Ruben Bridgewater)
    #30811
* stream:
  * add support for captureRejection option (Matteo Collina)
    #27867
* tls:
  * implement capture rejections for 'secureConnection' event (Matteo Collina)
    #27867
  * expose IETF name for current cipher suite (Sam Roberts)
    #30637
* worker:
  * add argv constructor option (legendecas)
    #30559

PR-URL: #30937
MylesBorins added a commit that referenced this pull request Dec 16, 2019
@MylesBorins
2019-12-17, Version 13.4.0 (Current)
f15fe94 
This is a security release.

For more details about the vulnerability please consult the npm blog:

https://blog.npmjs.org/post/189618601100/binary-planting-with-the-npm-cli

Notable Changes:
* deps:
  * update npm to 6.13.4
    #30904
  * update uvwasi (Anna Henningsen)
    #30745
  * upgrade to libuv 1.34.0 (Colin Ihrig)
    #30783
* doc:
  * docs deprecate http finished (Robert Nagy)
    #28679
* events:
  * add captureRejection option (Matteo Collina)
    #27867
* http:
  * add captureRejection support (Matteo Collina)
    #27867
  * llhttp opt-in insecure HTTP header parsing (Sam Roberts)
    #30567
* http2:
  * implement capture rection for 'request' and 'stream' events (Matteo Collina)
    #27867
* net:
  * implement capture rejections for 'connection' event (Matteo Collina)
    #27867
* repl:
  * support previews by eager evaluating input (Ruben Bridgewater)
    #30811
* stream:
  * add support for captureRejection option (Matteo Collina)
    #27867
* tls:
  * implement capture rejections for 'secureConnection' event (Matteo Collina)
    #27867
  * expose IETF name for current cipher suite (Sam Roberts)
    #30637
* worker:
  * add argv constructor option (legendecas)
    #30559

PR-URL: #30937
MylesBorins added a commit that referenced this pull request Dec 17, 2019
@MylesBorins
2019-12-17, Version 13.4.0 (Current)
bef1e87 
This is a security release.

For more details about the vulnerability please consult the npm blog:

https://blog.npmjs.org/post/189618601100/binary-planting-with-the-npm-cli

Notable Changes:
* deps:
  * update npm to 6.13.4
    #30904
  * update uvwasi (Anna Henningsen)
    #30745
  * upgrade to libuv 1.34.0 (Colin Ihrig)
    #30783
* doc:
  * docs deprecate http finished (Robert Nagy)
    #28679
* events:
  * add captureRejection option (Matteo Collina)
    #27867
* http:
  * add captureRejection support (Matteo Collina)
    #27867
  * llhttp opt-in insecure HTTP header parsing (Sam Roberts)
    #30567
* http2:
  * implement capture rection for 'request' and 'stream' events (Matteo Collina)
    #27867
* net:
  * implement capture rejections for 'connection' event (Matteo Collina)
    #27867
* repl:
  * support previews by eager evaluating input (Ruben Bridgewater)
    #30811
* stream:
  * add support for captureRejection option (Matteo Collina)
    #27867
* tls:
  * implement capture rejections for 'secureConnection' event (Matteo Collina)
    #27867
  * expose IETF name for current cipher suite (Sam Roberts)
    #30637
* worker:
  * add argv constructor option (legendecas)
    #30559

PR-URL: #30937
targos pushed a commit that referenced this pull request Jan 14, 2020
@ronag @targos
doc: deprecate http finished
ec514a6 
PR-URL: #28679
Refs: #28651
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@targos targos mentioned this pull request Jan 15, 2020
Closed
BethGriggs pushed a commit that referenced this pull request Feb 6, 2020
@ronag @BethGriggs
doc: deprecate http finished
79521d3 
PR-URL: #28679
Refs: #28651
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@MylesBorins MylesBorins mentioned this pull request Feb 8, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dougwilson dougwilson dougwilson left review comments

@ChALkeR ChALkeR ChALkeR left review comments

@mcollina mcollina mcollina approved these changes

@Trott Trott Trott approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

@addaleax addaleax Awaiting requested review from addaleax

@benjamingr benjamingr Awaiting requested review from benjamingr

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. deprecations Issues and PRs related to deprecations. http Issues or PRs related to the http subsystem. notable-change PRs with changes that should be highlighted in changelogs.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet