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

Skip breaking change detection in release pipeline #36370

Closed
Tracked by #35515
msyyc opened this issue Jul 5, 2024 · 6 comments
Closed
Tracked by #35515

Skip breaking change detection in release pipeline #36370

msyyc opened this issue Jul 5, 2024 · 6 comments
Assignees

Comments

@msyyc
Copy link
Member

msyyc commented Jul 5, 2024

We plan to adopt breaking changes tool when generating SDK so that we could recognize potential SDK breakings in advance. However, when open it for Mgmt SDK, it blocks SDK release so I have to revert it in #36104.

I understand one solution is follow https://github.com/Azure/azure-sdk-for-python/tree/main/scripts/breaking_changes_checker#types-of-breaking-changes-detected to suppress each breaking item but it is not flexible. Is there any way I can only adopt the tool but not block SDK release?

@raych1
Copy link
Member

raych1 commented Jul 16, 2024

@catalinaperalta
to integrate into the spec PR pipeline, the breaking change tool must support the detection within a specific service scope. This could be achieved by passing the service name when running the command of breaking change tool.

@catalinaperalta
Copy link
Member

catalinaperalta commented Jul 16, 2024

@catalinaperalta to integrate into the spec PR pipeline, the breaking change tool must support the detection within a specific service scope. This could be achieved by passing the service name when running the command of breaking change tool.

The tool is scoped to run within a specific sdk directory. Let me know if that's not what you meant

@catalinaperalta
Copy link
Member

@msyyc I'm thinking we could probably suppress all change reports for a specific library but you wont see what the breaking changes are for that library in the pipeline. Or do you want the pipeline not to block on the breaking changes check? I think the pipeline configuration should be changed in that case.

@msyyc
Copy link
Member Author

msyyc commented Jul 17, 2024

@catalinaperalta I find the way to disable breaking change:

steps:
- task: PythonScript@0
displayName: 'Run Breaking Changes'
inputs:
scriptPath: 'scripts/devops_tasks/dispatch_tox.py'
arguments: >-
"$(TargetingString)"
--mark_arg="${{ parameters.TestMarkArgument }}"
--service="${{ parameters.ServiceDirectory }}"
--toxenv="breaking"
--disablecov
env: ${{ parameters.EnvVars }}
condition: and(succeededOrFailed(), ne(variables['Skip.BreakingChanges'],'true'))
. We just need to set Skip.BreakingChanges as true then this step shall be skipped.
Let me check it and if it works, I will close this issue.

@catalinaperalta
Copy link
Member

@msyyc did your solution work?

@msyyc
Copy link
Member Author

msyyc commented Jul 26, 2024

I will try it after #36601 merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants