diff --git a/eng/common/instructions/azsdk-tools/verify-setup.instructions.md b/eng/common/instructions/azsdk-tools/verify-setup.instructions.md index 38d6a5b40db..be401efcd40 100644 --- a/eng/common/instructions/azsdk-tools/verify-setup.instructions.md +++ b/eng/common/instructions/azsdk-tools/verify-setup.instructions.md @@ -16,4 +16,4 @@ The user can specify multiple languages to check. If the user wants to check all ## Output Display results in a user-friendly and concise format, highlighting any missing dependencies that need to be addressed and how to resolve them. -WHENEVER Python related requirements fail, ALWAYS ASK the user if they have set the `AZSDKTOOLS_PYTHON_VENV_PATH` system environment variable to their desired virtual environment. This tool can only check requirements in the venv path specified by that environment variable. +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. diff --git a/tools/azsdk-cli/Azure.Sdk.Tools.Cli/Configuration/RequirementsV1.json b/tools/azsdk-cli/Azure.Sdk.Tools.Cli/Configuration/RequirementsV1.json index 0e81906f7eb..b9a6f66b96c 100644 --- a/tools/azsdk-cli/Azure.Sdk.Tools.Cli/Configuration/RequirementsV1.json +++ b/tools/azsdk-cli/Azure.Sdk.Tools.Cli/Configuration/RequirementsV1.json @@ -9,7 +9,7 @@ { "requirement": "tsp-client >= 0.24.0", "check": ["tsp-client", "--version"], - "instructions": ["cd eng/common/tsp-client", "`npm ci`"] + "instructions": ["cd eng/common/tsp-client", "npm ci"] }, { "requirement": "tsp >= 1.0.0", @@ -104,22 +104,22 @@ { "requirement": "azpysdk", "check": ["azpysdk", "--help"], - "instructions": ["Ensure your virtual environment is activated", "python -m pip install eng/tools/azure-sdk-tools[build]", "Check that it was installed with `azpysdk --help`"] + "instructions": ["Navigate to your SDK repository root directory", "Ensure your virtual environment is activated", "python -m pip install eng/tools/azure-sdk-tools[build]", "Check that it was installed with azpysdk --help"] }, { "requirement": "sdk_generator", "check": ["sdk_generator", "--help"], - "instructions": ["Ensure your virtual environment is activated", "python -m pip install eng/tools/azure-sdk-tools[sdk_generator]", "Check that it was installed with `sdk_generator --help`"] + "instructions": ["Navigate to your SDK repository root directory", "Ensure your virtual environment is activated", "python -m pip install eng/tools/azure-sdk-tools[sdk_generator]", "Check that it was installed with sdk_generator --help"] }, { "requirement": "ghtools", "check": ["python", "-m", "pip", "show", "GitPython"], - "instructions": ["Ensure your virtual environment is activated", "python -m pip install eng/tools/azure-sdk-tools[ghtools]", "Check that it was installed with `pip show GitPython`"] + "instructions": ["Navigate to your SDK repository root directory", "Ensure your virtual environment is activated", "python -m pip install eng/tools/azure-sdk-tools[ghtools]", "Check that it was installed with pip show GitPython"] }, { "requirement": "pytest >= 8.3.5", "check": ["pytest", "--version"], - "instructions": ["Ensure your virtual environment is activated", "python -m pip install pytest", "Check that it was installed with `pytest --version`"] + "instructions": ["Navigate to your SDK repository root directory", "Ensure your virtual environment is activated", "python -m pip install pytest", "Check that it was installed with pytest --version"] } ] } diff --git a/tools/azsdk-cli/Azure.Sdk.Tools.Cli/Models/Responses/VerifySetupResponse.cs b/tools/azsdk-cli/Azure.Sdk.Tools.Cli/Models/Responses/VerifySetupResponse.cs index ebf20d3ffc8..f44e8779676 100644 --- a/tools/azsdk-cli/Azure.Sdk.Tools.Cli/Models/Responses/VerifySetupResponse.cs +++ b/tools/azsdk-cli/Azure.Sdk.Tools.Cli/Models/Responses/VerifySetupResponse.cs @@ -15,6 +15,7 @@ public class VerifySetupResponse : CommandResponse protected override string Format() { var sb = new StringBuilder(); + sb.AppendLine("Results:"); if (Results != null)