Azure / Azure/azure-sdk-tools

Detect and Resolve mgmt. SDK Breaking Changes in early Stage

Open
#14,675 6 comments 0 reactions 1 assignee Claimed by @chunyu3 View on GitHub
AzSDK Tools Agent dev inner loop Epic Mgmt Mgmt-EngSys P0
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

## Background

Today, SDK breaking changes are often detected late in the release cycle, sometimes only during SDK generation. At that point, addressing the breaking change typically requires going back to update the API spec including client.tsp, which introduces additional rework and another round of coordination which also contributes to the long and unpredictable timeline after a spec PR is merged.

## Goal
Introduce mechanisms to detect and handle SDK breaking changes at an early stage, before spec merge or early enough that fixes do not disrupt the SDK release flow.

The idea is to shift breaking change detection left in the lifecycle, including:

Early identification of SDK breaking changes during:

- Spec authoring
- Pre-merge validation
- Code generation dry runs

Clear guidance on how to resolve breaking changes and leverage AI and code agent to solve the in client.tsp before starting the release.

This effort may involve multipart to coordinate.

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.