Add docs to avoid issues with CRLF line endings#869
Merged
jsoriano merged 3 commits intoelastic:mainfrom Jun 28, 2022
Merged
Conversation
Collaborator
Collaborator
🌐 Coverage report
|
24 tasks
mtojek
approved these changes
Jun 28, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When developing on Windows you may face issues because of CRLF line endings:
core.autocrlf=trueis enabled in git (common in Windows), files included in binaries withembedmay include CRLF line endings, causing issues when used in docker scenarios.core.autocrlf=false(usual default), file editors in Windows may add CRLF line endings in files.With
core.autocrlf=inputgit doesn't include CRLF when checking out files, and it removes the carriage return when commiting files, avoiding the unexpected presence of CRLF line endings.For example, this issue was found when running the Kibana healthcheck with an
elastic-packagebinary built on Windows: