Azure / Azure/azure-sdk-tools

Breaking change detection tooling should add `BreakingChangeReviewRequired` if `oad` (`openapi-diff`) throws runtime exception

Open
#7,770 0 comments 0 reactions 1 assignee Claimed by @konrad-jamrozik View on GitHub
Breaking Changes Central-EngSys Spec PR Tools
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

See [this Teams thread](https://teams.microsoft.com/l/message/19:0351f5f9404446e4b4fd4eaf2c27448d@thread.skype/1709003882755?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&parentMessageId=1709003882755&teamName=Azure%20SDK&channelName=API%20Spec%20Review&createdTime=1709003882755) for a bug report.

Affected PR:
- https://github.com/Azure/azure-rest-api-specs-pr/pull/17115
- https://dev.azure.com/azure-sdk/internal/_build/results?buildId=3529961&view=logs&j=98f87804-8e1f-5655-af02-e80aefa7aa97&t=65457206-7ab6-5966-2a2f-9ae3efa14a03

And also:
- https://github.com/Azure/azure-rest-api-specs-pr/pull/17227
- https://dev.azure.com/azure-sdk/internal/_build/results?buildId=3532477&view=logs&j=98f87804-8e1f-5655-af02-e80aefa7aa97&t=65457206-7ab6-5966-2a2f-9ae3efa14a03

Example error:
```
"new":"
https://github.com/Azure/azure-rest-api-specs-pr/blob/3fcb20ceb2511649033435fdac582c8550b336c7/specification/messagingconnector/resource-manager/Microsoft.MessagingConnectors/preview/2024-01-20-preview/messagingconnectors.json
",
"old":"
https://github.com/Azure/azure-rest-api-specs-pr/blob/RPSaaSMaster/specification/messagingconnector/resource-manager/Microsoft.MessagingConnectors/preview/2024-01-20-preview/messagingconnectors.json
",
"details":"incompatible properties : connectorDirection "
```

The mitigation for now is to add the label `BreakingChangeReviewRequired` manually.

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.