feat: add preflight environment validation via check command.#6724
Draft
NiravTech22 wants to merge 4 commits intoautowarefoundation:mainfrom
Draft
feat: add preflight environment validation via check command.#6724NiravTech22 wants to merge 4 commits intoautowarefoundation:mainfrom
NiravTech22 wants to merge 4 commits intoautowarefoundation:mainfrom
Conversation
…development environment prerequisites.
…development environment prerequisites.
|
Thank you for contributing to the Autoware project! 🚧 If your pull request is in progress, switch it to draft mode. Please ensure:
|
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
1 participant
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
This request introduces a new 'check' command along with a supporting 'check_environment' function to proactively validate development environment prerequisites before runtime .
The goal of this change is to fail fast and provide clear, actionable feedback when required tools, configurations, or dependencies are misconfigured/missing. By centralizing environment verification into a dedicated command, contributors can quickly diagnose setup issues without needing to run deeper workflows or encounter strange runtime errors.
Key improvements:
Adds a dedicated check command to the CLI/tooling surface.
Implements check_environment as a single source of truth for environment validation logic.
Improves developer experience by surfacing missing prerequisites early and explicitly.
Keeps behavior deterministic and non-destructive (read-only checks only).
Fork has been fully synced to ensure no divergence from upstream prior to submission.
How was this PR tested?
This change was PR tested using local manual validation, by running the new 'check' command in a correctly configured IDE to confirm all checks passed successfully. Output clarity and exit behavior were also classified under normal conditions during this test. A failure mode safety test was also run in order to simulate missing/misconfigured prerequisites for confirming if failures were detected reliably, error messages were explicit and actionable, and that there were no partial or misleading success states that occurred. The fork was also synced with upstream prior to applying the changes, and confirmed that there were no merge conflicts or unintended diffs outside the scope of this PR