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 detector] doesn't work well for multiapi package of Mgmt SDK #36755

Closed
Tracked by #35515
msyyc opened this issue Aug 5, 2024 · 4 comments · Fixed by #37100
Closed
Tracked by #35515

[breaking change detector] doesn't work well for multiapi package of Mgmt SDK #36755

msyyc opened this issue Aug 5, 2024 · 4 comments · Fixed by #37100
Assignees

Comments

@msyyc
Copy link
Member

msyyc commented Aug 5, 2024

For multiapi package of Mgmt SDK, current breaking change detector doesn't work well. For example:

(1) azure-mgmt-eventhub of PR #36724

  • chagnelog from detector
    image

  • changelog from old tool
    image

(2) azure-mgmt-compute of #36725

  • changelog from dector is empty
    image

  • changelog from old tool
    image

FYI: old changelog tool will generate code report for each api-version, then merge these code report into one, then generate changelog.

@github-actions github-actions bot added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Aug 5, 2024
@xiangyan99 xiangyan99 removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Aug 5, 2024
@catalinaperalta
Copy link
Member

catalinaperalta commented Aug 29, 2024

@msyyc I looked into this and the code report is reporting on all modules....however not incrementally as you mentioned that the old tool did. How was the "merge" performed in the old tool? Was the latest version merged on top of the last version released (preview or stable)? Or do we need to merge all module versions? And is there any value in that? Seems like merging with the last version should be enough to get the changes listed.

@catalinaperalta
Copy link
Member

catalinaperalta commented Aug 29, 2024

Could we compare the data from latest version against the last date-based version? So for the eventhub example you shared above, could we extract the api for version v2022_10_01_preview (we could merge the last stable version here as well to be safe) with the contents of v2024_01_01?

@msyyc
Copy link
Member Author

msyyc commented Aug 29, 2024

old tool will generate report for each api-versin subfolder then merge these reports. The merge logic is that sort the subfolder then update them one by one. So the latest api-version wins while some types that only exists in older api-version are still kept.

@msyyc I looked into this and the code report is reporting on all modules....however not incrementally as you mentioned that the old tool did. How was the "merge" performed in the old tool? Was the latest version merged on top of the last version released (preview or stable)? Or do we need to merge all module versions? And is there any value in that? Seems like merging with the last version should be enough to get the changes listed.

@catalinaperalta
Copy link
Member

Got it, I'll work on a way to do this in the new tool. Thanks for the info

@github-actions github-actions bot locked and limited conversation to collaborators Dec 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants