Repository navigation
feat(scripts): add Windows shell pre-flight check and WSL2 documentation - #263
Merged
Merged
Conversation
Collaborator
|
How does creating this dockerfile solve the issue? Are we expecting Windows users to:
I think the simplest response is to ditch the .devcontainer and recommend the user run the scripts inside a WSL environment |
Member
Author
|
Good call; Docker on Windows relies on WSL2 under the hood anyway, and expecting operators on client Windows machines to have Docker set up adds unnecessary friction. I removed |
Calvin-Cheng1
deleted the
feat/252-windows-preflight-and-devcontainer
branch
September 25, 2026 19:17
Closed
12 of 20 tasks
Merged
Calvin-Cheng1
pushed a commit
that referenced
this pull request
Oct 2, 2026
3 of 9 tasks
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.
Description
Adds a pre-flight shell check for unsupported native Windows shell environments and documents the WSL2 requirement and native Windows limitations.
In native Windows terminals (
MINGW64,MSYS,CYGWIN, or Windows shells outside WSL2), POSIX path handling, CRLF line endings, and symlink generation (ln -s) infast/stage-links.shandscripts/*.shcan fail midway through execution. This change:check_os_environmenttoscripts/common-functions.sh(invoked automatically bycheck_prerequisites) so scripts fail fast with guidance to use WSL2 or Google Cloud Shell when run from a native Windows shell, while passing normally on Linux, macOS, Cloud Shell, and WSL2.README.md,docs/prerequisites.md, andscripts/README.mdto document the WSL2 workstation requirement and explain the path, symlink, and line-ending limitations encountered in native Windows terminals.tests/scripts/test_common_functions.shcovering Linux, macOS, WSL2, MINGW64, Cygwin, and nativeWindows_NT.Fixes #252
Type of change
How Has This Been Tested?
bash tests/scripts/run_shell_tests.shverifying all 27 shell scripts pass syntax validation and all 19 unit assertions intests/scripts/test_common_functions.shpass.Checklist: