Breaking Changes PR check not flagging removed property as breaking

[mikekistler]

The Breaking Changes PR check in the azure-rest-api-specs repo is failing to flag a removed property as breaking and requiring a Breaking Change review.

REST API PR: Azure/azure-rest-api-specs#20009

The Breaking Changes-Cross Version PR check issued a warning for the removed property:

Here is the actual change:

Any property being removed should be flagged as a breaking change even in a new API version.

cc: @JeffreyRichter @srmantha

[jianyexi]

@mikekistler this is because all the api-versions of the RP are preview and no stable version, so the breaking change are allowed per breaking change policy , then we flag it as warning

[mikekistler]

Thanks @jianyexi, that's good to know. Could you please update the breaking changes doc in your PR to explain this subtle point? Thx.

[jianyexi]

@mikekistler it's already described in https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/ci-fix.md#breaking-change-check

[mikekistler]

Fair enough.

[mikekistler]

It seems that the situation is not quite as simple as this. The breaking changes check does flag some breaking changes as errors even when there is no prior GA version. PR #8244 is an example:

What is the explanation for why these breaking changes are reported as errors even though there is no prior GA version?

[jianyexi]

if we can know the last preview is over 1 year (consider the api-version as date ), we will consider it as stable version, it's already described in the documentation

[jianyexi]

One exception is that some data-plane Api-version follow the pattern like 'preview/v1', so we always treat them as preview version. let me know if you want to have different strategy