[breaking changes tracker] Update suppression mechanism to support more complex suppression scenarios

Azure / azure-sdk-for-python

This repository is for active development of the Azure SDK for Python. For consumers of the SDK we recommend visiting our public developer docs at https://learn.microsoft.com/python/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-python.

MIT License

4.56k stars 2.78k forks source link

[breaking changes tracker] Update suppression mechanism to support more complex suppression scenarios #35988

Closed catalinaperalta closed 2 weeks ago

catalinaperalta commented 3 months ago

We might want to suppress changes reported at the function or property level for all models or operations.
We may want to add suppressions across libraries.

Example: Mgmt plane libraries migrating to dpg will need to widely suppress changes between msrest and the new dpg design on all models.

catalinaperalta commented 3 months ago

Some scenarios to consider:

Suppress a change on a parameter in a whole library
Suppress a change on a method in a whole library
Suppress a change across multiple libraries. i.e. suppress the removed *ListResult model across all mgmt specs.

Should we be able to suppress a change with a regex to match model names following that pattern?

catalinaperalta commented 3 months ago

Do we also need an exception mechanism for mass suppressions? i.e. suppress changes reported throughout all of the mgmt libs except for one.

msyyc commented 3 months ago

Do we also need an exception mechanism for mass suppressions? i.e. suppress changes reported throughout all of the mgmt libs except for one.

As MGMT SDK owner, I hope we could have the exception mechanism.