Skip to content

Commit 2d6516d

Browse files
azure-sdkJennyPng
andauthored
Sync eng/common directory with azure-sdk-tools for PR 12476 (#43789)
* add tool instructions prompt * minor * prompt revision * prompt revision and fallback to core requirements * rename langs to languages + revise prompt * edit prompt and make checks concurrent * fix prompt * add venvPath argument * minor prompt and log edit --------- Co-authored-by: jennypng <[email protected]>
1 parent c003986 commit 2d6516d

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
description: 'Verify Setup'
3+
---
4+
5+
## 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.
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.
9+
10+
## Examples
11+
- 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>)`.
13+
14+
## 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.
18+
19+
## Output
20+
Display results in a user-friendly and concise format, highlighting any missing dependencies that need to be addressed.

0 commit comments

Comments
 (0)