Azure / Azure/azure-sdk-tools

Review the TSV validation suppression strategy

Open
#11,342 2 comments 0 reactions 1 assignee Assigned to @MaryGao View on GitHub
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

[Ashwin Mayya: JS SDK Validation check failing with package name mismatch](https://teams.microsoft.com/l/message/19:0351f5f9404446e4b4fd4eaf2c27448d@thread.skype/1753309786531?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&parentMessageId=1753309786531&teamName=Azure%20SDK&channelName=API%20Spec%20Review&createdTime=1753309786531)
posted in Azure SDK / API Spec Review on Wednesday, July 23, 2025 3:29 PM

This is a user reported issue related to SDK Validation failures. The root cause has been identified as incorrect setting for ‘@azure-tools/typespec-ts/package-details’ in the ‘tspconfig.yaml’ file. The error surfaced in the JS automation doesn’t indicate the real issues or suggest actionable fixes. Although we already have the ‘SdkTspConfigValidation’ rule in the TSV Validation check, it is currently suppressed for this service.

Since SDK Validation checks are now required, and incorrect emitter options might fail these checks, which turns out blocking the PR merge. To reduce repeated support efforts for these types of configuration issues, I propose leveraging the TSV Validation check to surface these errors more transparently. This aligns with the original intent behind adding these rules.

I know last time Mike tried to scope suppressions to only apply in ‘checkAll’ scenario, but it was reverted due to broadly impact to service teams.

To move forward, I suggest dividing suppressions into two groups:
#1 suppressions on specific emitter options, we should **make them invalid on service spec PR**.
#2 suppressions on emitter itself, these can remain as some service teams may opt out of SDK generation.

@wanlwanl could you make the suppression changes?

//CC: @maririos @weshaggard @mikeharder

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.