Azure / Azure/azure-sdk-tools

[PR Workflow][SDK] Flag the spec PR of brownfield service converting (migrating) to TypeSpec from Swagger

Open
#8,339 8 comments 0 reactions 1 assignee Assigned to @mikeharder View on GitHub
Central-EngSys Spec PR Tools TypeSpec
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
144

Description

**Context**
For brown field services of management plane, migrating to TypeSpec may introduce a few breaking changes to the SDK. We have observed that such spec PRs can be merged directly without the Shanghai SDK team's review. This is an [example spec PR](https://github.com/Azure/azure-rest-api-specs-pr/pull/17974)

This process could result in potential breaking change to the SDK haven't been evaluated, leading to additional efforts to mitigate these breaking changes post-merge.

**Proposal**
- Introduce a specific label, such as `TypeSpec-Migration`, to be automatically added to the spec PR by the bot.
- Shanghai SDK team will review the spec PRs with this label and work with service team to address any breaking changes.
- PR merge should be contingent upon the Shanghai SDK team adding `BreakingChange-Sdk-TypeSpecMigration-Approved` label if there are any Sdk breaking changes.

CC: @weshaggard @ArthurMa1978

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.