chore: enhance west command with safety check for init#3245
Open
prdktntwcklr wants to merge 1 commit intozmkfirmware:mainfrom
Open
chore: enhance west command with safety check for init#3245prdktntwcklr wants to merge 1 commit intozmkfirmware:mainfrom
prdktntwcklr wants to merge 1 commit intozmkfirmware:mainfrom
Conversation
b4537d1 to
14960cb
Compare
Introduces a safety check to the west command by modifying the .bashrc inside the devcontainer. The modification ensures that when running west init, users are reminded to include the -l app/ option, unless explicitly overridden.
14960cb to
79a3197
Compare
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.
Summary
After cloning the ZMK repository, developers must run
west initwith the-l app/option to correctly specify the local manifest repository (see docs). Omitting this option results in Zephyr being initialized in the wrong directory, leading to a misconfigured environment that is cumbersome and error-prone to clean up.This PR introduces a safety check to the
westcommand by modifying the.bashrcinside thedevcontainer. The modification ensures that when runningwest init, users are reminded to include the-l app/option, unless explicitly overridden.Key Changes
If
west initis run without the-loption, a warning message is displayed giving the user the option to bypass the check if needed:PR check-list