You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: eng/common/instructions/azsdk-tools/verify-setup.instructions.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: 'Verify Setup'
5
5
## Goal
6
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.
7
7
8
-
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.
8
+
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.
9
9
10
10
## Examples
11
11
- in `azure-sdk-for-js`, run `azsdk_verify_setup` with `(langs=javascript, packagePath=<path>/azure-sdk-for-js)`.
@@ -14,8 +14,8 @@ Your goal is to identify the project repo root, and pass in the `packagePath` to
14
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.
15
15
16
16
## Output
17
-
Display results in an informative and concise step-by-step instructional format, highlighting any missing dependencies that need to be addressed and how to resolve them. Organize requirements by language category.
17
+
Display clear, step-by-step instructions on how to resolve any missing requirements identified. Explain why the requirement is necessary if it has a `reason` field. Organize requirements into categorical sections.
18
18
19
-
Based on the user's shell environment, enhance the tool instructions with shell-specific commands for resolving missing dependencies. First output a summary of all missing requirements, and then begin trying to install each one for the user.
19
+
Based on the user's shell environment, enhance the tool instructions with shell-specific commands for resolving missing dependencies.
20
20
21
21
When Python tool requirements fail, inform the user about the `AZSDKTOOLS_PYTHON_VENV_PATH` environment variable if they have setup issues. The verify-setup tool can only check Python requirements within the virtual environment specified by this environment variable.
0 commit comments