-
Notifications
You must be signed in to change notification settings - Fork 142
Sync eng/common directory with azure-sdk-tools for PR 12476 #6816
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
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
5aa940f
add tool instructions prompt
JennyPng 21ec566
minor
JennyPng 27c4164
prompt revision
JennyPng cd918da
prompt revision and fallback to core requirements
JennyPng 2df9b1d
rename langs to languages + revise prompt
JennyPng 40766c7
edit prompt and make checks concurrent
JennyPng 58ab51e
fix prompt
JennyPng da131a4
add venvPath argument
JennyPng 5025473
minor prompt and log edit
JennyPng File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
20 changes: 20 additions & 0 deletions
20
eng/common/instructions/azsdk-tools/verify-setup.instructions.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| --- | ||
| description: 'Verify Setup' | ||
| --- | ||
|
|
||
| ## Goal | ||
| This tool verifies the developer's environment for SDK development and release tasks. It returns what requirements are missing for the specified languages and repo. | ||
|
|
||
| Your goal is to identify the project repo root, and pass in the `packagePath` to the Verify Setup tool. For a language repo, pass in the language of the repo. | ||
|
|
||
| ## Examples | ||
| - in `azure-sdk-for-js`, run `azsdk_verify_setup` with `(langs=javascript, packagePath=<path>/azure-sdk-for-js)`. | ||
| - in `azure-sdk-for-python`, run `azsdk_verify_setup` with `(langs=python, packagePath=<path>/azure-sdk-for-python, venvPath=<path-to-venv>)`. | ||
|
|
||
| ## Parameter Requirements | ||
| WHENEVER Python is included in `langs`, BEFORE RUNNING `azsdk_verify_setup`, you MUST ASK THE USER TO SPECIFY WHICH virtual environment they want to check. DO NOT ASSUME THE VENV WITHOUT ASKING THE USER. After obtaining the `venvPath`, you can run the tool. | ||
|
|
||
| The user can specify multiple languages to check. If the user wants to check all languages, pass in ALL supported languages and STILL ASK for a `venvPath`. Passing in no languages will only check the core requirements. | ||
JennyPng marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Output | ||
| Display results in a user-friendly and concise format, highlighting any missing dependencies that need to be addressed. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.