Skip to content

Commit d5a1d74

Browse files
azure-sdkJennyPng
andauthored
Sync eng/common directory with azure-sdk-tools for PR 12867 (#43976)
Co-authored-by: jennypng <63012604+JennyPng@users.noreply.github.com>
1 parent 0b6fd42 commit d5a1d74

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

eng/common/instructions/azsdk-tools/verify-setup.instructions.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,17 @@ description: 'Verify Setup'
33
---
44

55
## Goal
6-
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.
6+
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, or success if all requirements are satisfied.
77

88
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.
99

1010
## Examples
1111
- in `azure-sdk-for-js`, run `azsdk_verify_setup` with `(langs=javascript, packagePath=<path>/azure-sdk-for-js)`.
12-
- in `azure-sdk-for-python`, run `azsdk_verify_setup` with `(langs=python, packagePath=<path>/azure-sdk-for-python, venvPath=<path-to-venv>)`.
1312

1413
## Parameter Requirements
15-
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.
16-
17-
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.
14+
The user can specify multiple languages to check. If the user wants to check all languages, pass in ALL supported languages. Passing in no languages will only check the core requirements.
1815

1916
## Output
20-
Display results in a user-friendly and concise format, highlighting any missing dependencies that need to be addressed.
17+
Display results in a user-friendly and concise format, highlighting any missing dependencies that need to be addressed and how to resolve them.
18+
19+
WHENEVER Python related requirements fail, ALWAYS ASK the user if they have set the `AZSDKTOOLS_PYTHON_VENV_PATH` system environment variable to their desired virtual environment. This tool can only check requirements in the venv path specified by that environment variable.

0 commit comments

Comments
 (0)