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

On Windows, Stardoc inserts carriage return characters after processing each template #110

Closed
tetromino opened this issue Oct 4, 2021 · 2 comments · Fixed by #152
Closed

Comments

@tetromino
Copy link
Collaborator

On Windows, Stardoc seems to insert a superfluous carriage return character in markdown output at the end of each processed template (not end of each line).

This means Stardoc's output on Windows is not byte-identical to the output Linux - which, among other things, prevents us from migrating to bazel-skylib's diff_test.

See the CI runs for 900f9f0 which passed on Linux and macOS (https://buildkite.com/bazel/stardoc/builds/235#44e0a148-360c-48e3-aa07-215f796d5b7c) but failed on Windows (https://buildkite.com/bazel/stardoc/builds/235#6dc4c463-853d-47b3-8fee-9dffcdf30e2d).

@alexeagle
Copy link
Contributor

FWIW I think there may be a bug in bazel-skylib. I've had to bypass Windows CI for some rules_nodejs uses of diff_test, again the content should be identical on linux.
https://github.com/bazelbuild/rules_nodejs/blob/fafb12fe6c9bb39b064665b652b645468aa9bf6b/docs/BUILD.bazel#L63 is the spot.

@alexeagle
Copy link
Contributor

Ah, got out a windows laptop and you're right. My other diff_test problems were also because of stardoc output being platform-sensitive.

tetromino pushed a commit that referenced this issue May 16, 2023
Required updating the pinned Bazel commit and importing a patch to rules_jvm_external from the Bazel source tree.

Fixes #110
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants