Azure / Azure/azure-rest-api-specs

[BUG] PR Automation mislabels breaking change as VersionReviewRequired

Open
#38,540 0 comments 0 reactions 1 assignee Claimed by @mikeharder View on GitHub
bug Spec PR Tools
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
3d 2h
Merged PRs (30d)
424

Description

### API Spec link

https://github.com/Azure/azure-rest-api-specs/pull/38517

### API Spec version

NA

### Describe the bug

The breaking change PR checks should apply the BreakingChangeReviewRequired label when the PR makes breaking changes in the same API version. The VersioningReviewRequired label is appropriate when the PR makes changes to an existing API version that would not be breaking if made in a new API version.

This is not working correctly in some cases, as illustrated in PR #38517.

The [Swagger BreakingChange check](https://github.com/Azure/azure-rest-api-specs/actions/runs/18939286077) finds that enum values have been removed -- a breaking change

Image

but applied the VersioningReviewRequired label rather than the BreakingChangeReviewRequired label.

Image

### Expected behavior

The breaking change PR checks should apply the BreakingChangeReviewRequired label when the PR makes breaking changes in the same API version. The VersioningReviewRequired label is appropriate when the PR makes changes to an existing API version that would not be breaking if made in a new API version.

### Actual behavior

See description.

### Reproduction Steps

See the linked PR check report.

### Environment

_No response_

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.