Skip to content

Commit 14c4858

Browse files
azure-sdkJennyPng
andauthored
Sync eng/common directory with azure-sdk-tools for PR 13100 (#36847)
Sync eng/common directory with azure-sdk-tools for PR Azure/azure-sdk-tools#13100 See [eng/common workflow](https://github.com/Azure/azure-sdk-tools/blob/main/eng/common/README.md#workflow) --------- Co-authored-by: jennypng <[email protected]>
1 parent 43e5ad6 commit 14c4858

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: 'Verify Setup'
55
## Goal
66
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

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

1010
## Examples
1111
- in `azure-sdk-for-js`, run `azsdk_verify_setup` with `(langs=javascript, packagePath=<path>/azure-sdk-for-js)`.
@@ -14,6 +14,8 @@ Your goal is to identify the project repo root, and pass in the `packagePath` to
1414
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.
1515

1616
## Output
17-
Display results in a user-friendly and concise format, highlighting any missing dependencies that need to be addressed and how to resolve them.
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+
19+
Based on the user's shell environment, enhance the tool instructions with shell-specific commands for resolving missing dependencies.
1820

1921
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

Comments
 (0)