Azure / azure-sdk-tools

Tools repository leveraged by the Azure SDK team.
MIT License
111 stars 176 forks source link

[SDK Automation - Java] Support breaking change detection for DPG & MPG #8477

Closed XiaofeiCao closed 2 months ago

XiaofeiCao commented 3 months ago

Offline synced with Ray, we need:

  1. List breaking changes in Breaking Changes section in changelog.md
  2. List breaking changes in output, format: https://github.com/Azure/azure-rest-api-specs/blob/cc92c5922e1d69bab8f0deb8e1f778f6d9455739/documentation/sdkautomation/GenerateOutputSchema.json#L49 image

/cc @raych1 @weidongxu-microsoft

weidongxu-microsoft commented 3 months ago
  1. breaking changes should always compare with a previous GA SDK
  2. there could be issue about version (in current SDK automation, we don't set a version to package)
XiaofeiCao commented 3 months ago
  1. breaking changes should always compare with a previous GA SDK
  2. there could be issue about version (in current SDK automation, we don't set a version to package)

Thanks, there could be a case where previously we released beta SDK for GA service, or never released at all. This case, we are not able to generate breaking changes since we can't find the SDK to compare with. @raych1

raych1 commented 3 months ago
  1. breaking changes should always compare with a previous GA SDK
  2. there could be issue about version (in current SDK automation, we don't set a version to package)

Thanks, there could be a case where previously we released beta SDK for GA service, or never released at all. This case, we are not able to generate breaking changes since we can't find the SDK to compare with. @raych1

@XiaofeiCao , it's ok to return false if a SDK hasn't have any GA version released.

raych1 commented 3 months ago
  1. there could be issue about version (in current SDK automation, we don't set a version to package)

SDK automation doesn't need to know the package version. It's up to the language tool to pick up the base version and do comparison then report the breaking change.