Skip to content

Address usability experience for azsdk verify-setup #12976

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 21, 2025
Merged

Address usability experience for azsdk verify-setup #12976

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3e235c2
Address usability experience for azsdk verify-setup
samvaity Nov 18, 2025
d6c822c
address reqs setup prereq
samvaity Nov 18, 2025
fe1da59
Update eng/common/instructions/azsdk-tools/verify-setup.instructions.md
samvaity Nov 19, 2025
05b86ec
remove backticks from commands
samvaity Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion eng/common/instructions/azsdk-tools/verify-setup.instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
10 changes: 5 additions & 5 deletions tools/azsdk-cli/Azure.Sdk.Tools.Cli/Configuration/RequirementsV1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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`"]
}
]
}
Expand Down
1 change: 1 addition & 0 deletions tools/azsdk-cli/Azure.Sdk.Tools.Cli/Models/Responses/VerifySetupResponse.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ public class VerifySetupResponse : CommandResponse
protected override string Format()
{
var sb = new StringBuilder();

sb.AppendLine("Results:");

if (Results != null)
Expand Down
Loading