docs(tests): document the Windows skip convention for shell-based tests#122
Merged
Conversation
CI runs the suite on ubuntu, macos and windows-latest, while everything under scripts/ is POSIX Bash — so any test that invokes bash, sources a scripts/lib/*.sh helper, or runs an installer fails on the Windows leg. Thirteen test files already use the skip_on_windows marker, but the convention was undocumented and is invisible locally: the suite is green on Linux and only the Windows CI leg turns red. Came from /retro: yes Signed-off-by: Sebastian Mendel <github@sebastianmendel.de>
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
|
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
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.
CI runs the suite on
ubuntu-latest,macos-latestandwindows-latest, whileeverything under
scripts/is POSIX Bash. Any test that invokesbash, sources ascripts/lib/*.shhelper, or executes an installer fails on the Windows leg.Thirteen test files already use the
skip_on_windowsmarker, but the convention wasundocumented — so it gets re-derived the hard way. It is invisible locally: the suite
is green on Linux and only the Windows CI leg turns red (this happened on #120 and
again on #121 during this work).
Documents the marker, and that it applies to the shell-invoking class only — pure
Python assertions (catalog JSON structure, schema invariants) must keep running on
every platform.
Docs only; no code or test changes.
Came from /retro: yes