-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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
Conversation
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
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: test
-> tests
?
There was a problem hiding this comment.
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
This should be fixed by #20754 and adding the comment is not necessary anymore with that PR. |
The issue that the comment mentions got fixed with #20754. Closing. |
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. |
There was a problem hiding this 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.
Landed in 3654cd4 |
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 <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]>
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 <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]>
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 <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]>
Adds a note to
test/README.md
that settingautocrlf
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