diff --git a/eng/common/instructions/azsdk-tools/verify-setup.instructions.md b/eng/common/instructions/azsdk-tools/verify-setup.instructions.md new file mode 100644 index 0000000000..284e384177 --- /dev/null +++ b/eng/common/instructions/azsdk-tools/verify-setup.instructions.md @@ -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=/azure-sdk-for-js)`. +- in `azure-sdk-for-python`, run `azsdk_verify_setup` with `(langs=python, packagePath=/azure-sdk-for-python, venvPath=)`. + +## 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.