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

doc: add note about autocrlf required for tests #20752

Closed
wants to merge 2 commits into from

Conversation

bzoz
Copy link
Contributor

@bzoz bzoz commented May 15, 2018

Adds a note to test/README.md that setting autocrlf to true when checking out sources is required for the tests to run successfully.

See #18967, which will fail if the autocrlf is set to false.

Checklist

Adds a note to test/README.md that setting autocrlf to true when
checking out sources is required for the tests to run successfully.

Ref: nodejs#18967
@bzoz bzoz requested a review from a team as a code owner May 15, 2018 18:52
@nodejs-github-bot nodejs-github-bot added the test Issues and PRs related to the tests. label May 15, 2018
@vsemozhetbyt vsemozhetbyt added the windows Issues and PRs related to the Windows platform. label May 15, 2018
@vsemozhetbyt
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 15, 2018
test/README.md Outdated
@@ -8,6 +8,9 @@ directory, see [the guide on writing tests](../doc/guides/writing-tests.md).
On how to run tests in this directory, see
[the contributing guide](../doc/guides/contributing/pull-requests.md#step-6-test).

For the test to successfully run on Windows, Node.js has to be checked out from
Copy link
Member

Choose a reason for hiding this comment

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

Nit: test -> tests?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right, I'll fix it

@bzoz
Copy link
Contributor Author

bzoz commented May 16, 2018

@BridgeAR
Copy link
Member

This should be fixed by #20754 and adding the comment is not necessary anymore with that PR.

@BridgeAR BridgeAR removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 18, 2018
@BridgeAR
Copy link
Member

The issue that the comment mentions got fixed with #20754. Closing.

@BridgeAR BridgeAR closed this May 18, 2018
@bzoz bzoz reopened this May 21, 2018
@bzoz
Copy link
Contributor Author

bzoz commented May 21, 2018

CI has autocrlf set to true, so we will never know if a change does not break test for setups with autocrlf set to false. I would add this note to the docs.

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 21, 2018
Copy link
Member

@apapirovski apapirovski left a comment

Choose a reason for hiding this comment

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

I'm in favour of documenting this even if it's currently not needed.

@apapirovski
Copy link
Member

Landed in 3654cd4

apapirovski pushed a commit that referenced this pull request May 22, 2018
Adds a note to test/README.md that setting autocrlf to true when
checking out sources is required for the tests to run successfully.

PR-URL: #20752
Ref: #18967
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
MylesBorins pushed a commit that referenced this pull request May 22, 2018
Adds a note to test/README.md that setting autocrlf to true when
checking out sources is required for the tests to run successfully.

PR-URL: #20752
Ref: #18967
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
@addaleax addaleax mentioned this pull request May 22, 2018
MylesBorins pushed a commit that referenced this pull request May 23, 2018
Adds a note to test/README.md that setting autocrlf to true when
checking out sources is required for the tests to run successfully.

PR-URL: #20752
Ref: #18967
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. test Issues and PRs related to the tests. windows Issues and PRs related to the Windows platform.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants