Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Breaking Change][PR Workflow] Breaking Changes should not flag breaks from prior preview as errors #6396

Closed
mikekistler opened this issue Jun 23, 2023 · 2 comments
Assignees
Labels
Breaking Changes Improvements to Breaking Changes tooling bug This issue requires a change to an existing behavior in the product in order to be resolved. Central-EngSys This issue is owned by the Engineering System team. openapi-alps Items pertaining to https://devdiv.visualstudio.com/DevDiv/_git/openapi-alps/ Spec PR Tools Tooling that runs in azure-rest-api-specs repo.

Comments

@mikekistler
Copy link
Member

mikekistler commented Jun 23, 2023

New API versions, either preview or GA, may have breaking changes from prior previews - this is allowed by the Azure Breaking Change policy. But the current Breaking Changes PR check in the azure-rest-api-specs repo flags these as errors and triggers a breaking change review. This should be changed to flag these only as warnings and bypass breaking change review.

An example: Azure/azure-rest-api-specs#24494

This issue belongs to a set of related (and possibly at least partially duplicate) issues:

@mikekistler mikekistler added Spec PR Tools Tooling that runs in azure-rest-api-specs repo. Breaking Changes Improvements to Breaking Changes tooling labels Jun 23, 2023
@konrad-jamrozik konrad-jamrozik added the Central-EngSys This issue is owned by the Engineering System team. label Jun 27, 2023
@konrad-jamrozik konrad-jamrozik changed the title Breaking Changes should not flag breaks from prior preview as errors [Breaking change] Breaking Changes should not flag breaks from prior preview as errors Jun 27, 2023
@konrad-jamrozik konrad-jamrozik changed the title [Breaking change] Breaking Changes should not flag breaks from prior preview as errors [PR Workflow][Breaking change] Breaking Changes should not flag breaks from prior preview as errors Jun 27, 2023
@konrad-jamrozik konrad-jamrozik moved this from 🤔 Triage to 📋 Backlog in Azure SDK EngSys 🚢🎉 Jun 27, 2023
@konrad-jamrozik konrad-jamrozik moved this to 📋 Backlog in Spec PR Tools Jun 27, 2023
@konrad-jamrozik konrad-jamrozik self-assigned this Jun 27, 2023
@konrad-jamrozik konrad-jamrozik changed the title [PR Workflow][Breaking change] Breaking Changes should not flag breaks from prior preview as errors [Breaking Change][PR Workflow] Breaking Changes should not flag breaks from prior preview as errors Jun 27, 2023
@konrad-jamrozik konrad-jamrozik added the openapi-alps Items pertaining to https://devdiv.visualstudio.com/DevDiv/_git/openapi-alps/ label Nov 29, 2023
@konrad-jamrozik
Copy link
Contributor

konrad-jamrozik commented Feb 5, 2024

Recent case from Mike:

Here is a recent PR with no BreakingChange / Versioning label but the Automated Merging Requirements check is blocking merge due to a failing Swagger Breaking Changes check:
https://github.com/Azure/azure-rest-api-specs-pr/pull/16902

@konrad-jamrozik
Copy link
Contributor

PR with a fix:

  • Pull Request 526579: Do not fail breaking change checks if only OAD failures are related to previews

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking Changes Improvements to Breaking Changes tooling bug This issue requires a change to an existing behavior in the product in order to be resolved. Central-EngSys This issue is owned by the Engineering System team. openapi-alps Items pertaining to https://devdiv.visualstudio.com/DevDiv/_git/openapi-alps/ Spec PR Tools Tooling that runs in azure-rest-api-specs repo.
Projects
Archived in project
Status: 🎊 Closed
Development

No branches or pull requests

2 participants