-
Notifications
You must be signed in to change notification settings - Fork 90
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
docs(rtd): update windows instructions #718
docs(rtd): update windows instructions #718
Conversation
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.
git config --global core.autocrlf input
needs to be included in the documentation too. Without this, the build fails with 277k+ errorsExpected linebreaks to be 'LF' but found 'CRLF' linebreak-style
.- I'm not seeing commitizen install mentioned, should that be here too?
|
||
npm run build | ||
|
||
At the time of this writing, ``yarn`` has a bug with the ``script-shell`` config. A fix has already been committed and should make their next non-patch release. After that you can use ``yarn run build`` or just ``yarn build`` if you prefer. |
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.
At the time of this writing, ``yarn`` has a bug with the ``script-shell`` config. A fix has already been committed and should make their next non-patch release. After that you can use ``yarn run build`` or just ``yarn build`` if you prefer. | |
At the time of this writing, ``yarn`` has a [bug](https://github.com/yarnpkg/yarn/issues/5699) with the ``script-shell`` config. A fix has already been committed and should make their next non-patch release. After that you can use ``yarn run build`` or just ``yarn build`` if you prefer. |
|
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.
- Did you do a fresh clone of the repositories? The line endings are wrong without that setting. I started with a fresh install of git too, so I had the default config when I originally encountered the errors during build.
core.autocrlf=true
, cloneopensphere-yarn-workspace
, cloneopensphere
,yarn install
,npm run lint:js
core.autocrlf=input
, clone opensphere-yarn-workspace
, clone opensphere
, yarn install
, npm run lint:js
(no errors)
- Agree.
Yes, it was a fresh clone. I did do the original clone in cygwin though. Edit: That's the difference. Cygwin, being a full POSIX environment, uses linux-style line endings. I'll add a |
Updates our Windows development documentation by moving it to the RTD docs and updating it per ngageoint/opensphere-build-resolver#46.