Sync eng/common directory with azure-sdk-tools for PR 12476 (#6816)
* 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 <63012604+JennyPng@users.noreply.github.com>
This commit is contained in:
parent
074d372c96
commit
53af908ebc
@ -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.
|
||||
|
||||
## Output
|
||||
Display results in a user-friendly and concise format, highlighting any missing dependencies that need to be addressed.
|
||||
Loading…
Reference in New Issue
Block a user