doc: added example for setting Vary: Accept-Encoding header in zlib.md #26308

mukulkhanna · 2019-02-26T01:00:51Z

Resolving issue #25495.
Added example to set Vary: Accept-Encoding header with explanatory comment to doc/api/zlib.md

Checklist

documentation is changed or added
commit message follows commit guidelines

Trott · 2019-02-26T06:48:28Z

doc/api/zlib.md

@@ -107,6 +107,8 @@ const http = require('http');
 const fs = require('fs');
 http.createServer((request, response) => {
  const raw = fs.createReadStream('index.html');
+  // instruct the proxy to store both a compressed and uncompressed version of the resource


Hi, @mukulkhanna! Welcome and thanks for the pull request! This line above is (probably) going to cause the linter to complain. Could you wrap the comment at 80 characters and capitalize the first letter of the first word? (Might as well put a period/full-stop at the end while you're at it.)

Oh, and you can check the linting with make lint (or vcbuild lint on Windows).

Hi @Trott.
Sure, will do asap, thank you.

Trott · 2019-02-26T09:49:02Z

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

doc/api/zlib.md

mukulkhanna · 2019-02-26T15:44:14Z

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

@Trott ,
I don't have overall/read access to the link.

Co-Authored-By: mukulkhanna <[email protected]>

Trott · 2019-02-26T19:15:51Z

I don't have overall/read access to the link.

Correct. CI is currently locked down while it is being used to prepare the security release that is scheduled to come out in the next several hours.

Trott · 2019-02-26T19:16:55Z

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

(Results should be reported in the GitHub widget below.)

mukulkhanna · 2019-02-26T19:33:53Z

The 'first' commit message is failing the test.

Is this the first commit of this pull request or is this about the most recent commit in the pull request.

Trott · 2019-02-26T19:39:26Z

The 'first' commit message is failing the test.

Is this the first commit of this pull request or is this about the most recent commit in the pull request.

It's the first word of the last commit, but don't worry about it. Whoever lands this commit will need to squash the commits into one and modify the commit message to conform to our requirements anyway.

The Travis stuff is advisory, but the other two checks from Jenkins are green and those are the ones that matter.

richardlau · 2019-02-27T00:21:22Z

The 'first' commit message is failing the test.
Is this the first commit of this pull request or is this about the most recent commit in the pull request.

It's the first word of the last commit, but don't worry about it. Whoever lands this commit will need to squash the commits into one and modify the commit message to conform to our requirements anyway.

The Travis stuff is advisory, but the other two checks from Jenkins are green and those are the ones that matter.

Actually the Travis failure is the first commit: https://travis-ci.com/nodejs/node/jobs/180651661#L476-L486

*** Commit message for d510b68c0d is:
doc: added example for setting Vary: Accept-Encoding header in zlib.md
+npx -q core-validate-commit --no-validate-metadata d510b68c0d167d26964da3a8d3aa37df4ecb2866
  ✖  d510b68c0d167d26964da3a8d3aa37df4ecb2866
     ✔  0:0      skipping fixes-url                        fixes-url
     ✔  0:0      blank line after title                    line-after-title
     ✔  0:0      line-lengths are valid                    line-length
     ✔  0:0      valid subsystems                          subsystem
     ✖  0:38     First word after subsystem(s) in title should be lowercase. title-format
     ⚠  0:50     Title should be <= 50 columns.            title-length

In this case core-validate-commit is incorrectly treating Accept-Encoding as a first word after subsystem(s) as it comes after a second :. I'll raise a PR to fix core-validate-commit. (Edit: nodejs/core-validate-commit#48)

Trott · 2019-02-27T02:25:10Z

Actually the Travis failure is the first commit: https://travis-ci.com/nodejs/node/jobs/180651661#L476-L486

@richardlau Ooh, I didn't even consider that it's a bug. (And I'm the one that initially set up Travis to always lint the first commit and no other commit! You'd think I'd remember that. 😆) Nice catch! Sorry for the bad information!

mukulkhanna · 2019-02-27T04:46:42Z

@Trott Can I close this pull request or should I wait for it to be merged ?

Trott · 2019-02-27T05:57:34Z

@Trott Can I close this pull request or should I wait for it to be merged ?

Leave this pull request open. Thanks!

richardlau · 2019-02-28T17:34:47Z

Actually the Travis failure is the first commit: https://travis-ci.com/nodejs/node/jobs/180651661#L476-L486

@richardlau Ooh, I didn't even consider that it's a bug. (And I'm the one that initially set up Travis to always lint the first commit and no other commit! You'd think I'd remember that. 😆) Nice catch! Sorry for the bad information!

FTR I've pushed out a fix to core-validate-commit and reran the failing the Travis job (which now passes 🎉).

PR-URL: nodejs#26308 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

Trott · 2019-02-28T20:42:32Z

Landed in 86f13d6.

Thanks for the contribution! 🎉

PR-URL: #26308 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

doc: added example for setting Vary: Accept-Encoding header in zlib.md

d510b68

nodejs-github-bot added doc Issues and PRs related to the documentations. zlib Issues and PRs related to the zlib subsystem. labels Feb 26, 2019

jasnell approved these changes Feb 26, 2019

View reviewed changes

BridgeAR approved these changes Feb 26, 2019

View reviewed changes

Trott reviewed Feb 26, 2019

View reviewed changes

docs: adhere to linting rules

83335ea

Trott reviewed Feb 26, 2019

View reviewed changes

doc/api/zlib.md Outdated Show resolved Hide resolved

Fixes: nodejs#25495

2b7f394

Co-Authored-By: mukulkhanna <[email protected]>

richardlau mentioned this pull request Feb 27, 2019

rules: only check case of first word after subsystem nodejs/core-validate-commit#48

Merged

Trott pushed a commit to Trott/io.js that referenced this pull request Feb 28, 2019

doc: add example for setting Vary: Accept-Encoding header in zlib.md

86f13d6

PR-URL: nodejs#26308 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

Trott closed this Feb 28, 2019

addaleax mentioned this pull request Feb 28, 2019

Vary: Accept-Encoding missing in zlib examples #25495

Closed

addaleax pushed a commit that referenced this pull request Mar 1, 2019

doc: add example for setting Vary: Accept-Encoding header in zlib.md

40a5a93

PR-URL: #26308 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

BridgeAR mentioned this pull request Mar 4, 2019

v11.11.0 proposal #26322

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: added example for setting Vary: Accept-Encoding header in zlib.md #26308

doc: added example for setting Vary: Accept-Encoding header in zlib.md #26308

mukulkhanna commented Feb 26, 2019

Trott Feb 26, 2019

Trott Feb 26, 2019

mukulkhanna Feb 26, 2019

Trott commented Feb 26, 2019

mukulkhanna commented Feb 26, 2019 •

edited

Loading

Trott commented Feb 26, 2019

Trott commented Feb 26, 2019

mukulkhanna commented Feb 26, 2019

Trott commented Feb 26, 2019

richardlau commented Feb 27, 2019 •

edited

Loading

Trott commented Feb 27, 2019

mukulkhanna commented Feb 27, 2019

Trott commented Feb 27, 2019

richardlau commented Feb 28, 2019

Trott commented Feb 28, 2019

doc: added example for setting Vary: Accept-Encoding header in zlib.md #26308

doc: added example for setting Vary: Accept-Encoding header in zlib.md #26308

Conversation

mukulkhanna commented Feb 26, 2019

Checklist

Trott Feb 26, 2019

Choose a reason for hiding this comment

Trott Feb 26, 2019

Choose a reason for hiding this comment

mukulkhanna Feb 26, 2019

Choose a reason for hiding this comment

Trott commented Feb 26, 2019

mukulkhanna commented Feb 26, 2019 • edited Loading

Trott commented Feb 26, 2019

Trott commented Feb 26, 2019

mukulkhanna commented Feb 26, 2019

Trott commented Feb 26, 2019

richardlau commented Feb 27, 2019 • edited Loading

Trott commented Feb 27, 2019

mukulkhanna commented Feb 27, 2019

Trott commented Feb 27, 2019

richardlau commented Feb 28, 2019

Trott commented Feb 28, 2019

mukulkhanna commented Feb 26, 2019 •

edited

Loading

richardlau commented Feb 27, 2019 •

edited

Loading