Skip to content

Sync eng/common directory with azure-sdk-tools for PR 12454 #6781

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 3 commits into from
Oct 13, 2025
+11 −9
Merged

Sync eng/common directory with azure-sdk-tools for PR 12454 #6781

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6619edb
Revise tsp-client usage instructions in README
raych1 Oct 10, 2025
e78c678
Update README.md to use brace expansion for variables
raych1 Oct 10, 2025
73733fe
Update README.md
raych1 Oct 10, 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
20 changes: 11 additions & 9 deletions eng/common/tsp-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,30 +25,32 @@ npm ci

## Usage

After installation, you can run tsp-client by navigating to the directory and using npm exec:
After installation, you can run `tsp-client` using `npm exec --prefix {path_to_the_eng/common/tsp-client}`.
Note that you should *not* navigate into the `eng/common/tsp-client` folder, since several `tsp-client` commands require the current working directory to be the client library's root.

```bash
cd eng/common/tsp-client
# Set the tsp-client directory path relative to your current working directory
_TspClientDir=eng/common/tsp-client

# Get help
npm exec --no -- tsp-client --help
npm exec --prefix ${_TspClientDir} --no -- tsp-client --help

# Check version
npm exec --no -- tsp-client version
npm exec --prefix ${_TspClientDir} --no -- tsp-client version

# Generate client code
npm exec --no -- tsp-client generate --output-dir ./generated
npm exec --prefix ${_TspClientDir} --no -- tsp-client generate --output-dir ./generated

# Initialize a new project
npm exec --no -- tsp-client init --tsp-config ./tspconfig.yaml
npm exec --prefix ${_TspClientDir} --no -- tsp-client init --tsp-config ./tspconfig.yaml
```

## CI/CD Best Practices

```bash
cd eng/common/tsp-client
npm ci
npm exec --no -- tsp-client init --update-if-exists --tsp-config https://github.com/Azure/azure-rest-api-specs/blob/dee71463cbde1d416c47cf544e34f7966a94ddcb/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml
_TspClientDir=eng/common/tsp-client
npm ci --prefix ${_TspClientDir}
npm exec --prefix ${_TspClientDir} --no -- tsp-client init --update-if-exists --tsp-config https://github.com/Azure/azure-rest-api-specs/blob/dee71463cbde1d416c47cf544e34f7966a94ddcb/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml
```

## Package Management
Expand Down