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

Permit users to choose latest preview version or latest stable version in pypi to compare #36371

Closed
Tracked by #35515
msyyc opened this issue Jul 5, 2024 · 3 comments · Fixed by #36517
Closed
Tracked by #35515
Assignees

Comments

@msyyc
Copy link
Member

msyyc commented Jul 5, 2024

Now Mgmt SDK follow the following rule to generate changelog:

  • If we are going to release preview package, we will compare with latest public package no matter it is preview or stable to generate changelog
  • If we are going to release stable package, we will compare with latest public stable package to generate SDK

So we hope breaking change detector could add config like --latest-stable,

  • when true, compare with latest stable version in pypi
  • when false, compared with latest version in pypi, no matter it is stable or preview.

For example, if a package named "azure-mgmt-test" has already 1.0.0b1, 1.0.0, 1.1.0b1 in pypi,

  • if is going to release new preview version, there is need to compare with 1.1.0b1
  • if is gong to release new stale version, there is need to compare with 1.00
@msyyc msyyc self-assigned this Jul 5, 2024
@msyyc msyyc changed the title Permit users to choose latest preview or latest stable public version to compare Permit users to choose latest preview version or latest stable version in pypi to compare Jul 5, 2024
@msyyc msyyc assigned catalinaperalta and unassigned msyyc Jul 16, 2024
@raych1
Copy link
Member

raych1 commented Jul 16, 2024

@catalinaperalta
please prioritize this issue as it is blocking the integration with the spec PR pipeline.

@catalinaperalta
Copy link
Member

looking into this

@catalinaperalta
Copy link
Member

catalinaperalta commented Jul 19, 2024

FYI I have a PR addressing this issue. Adding a --latest-pypi-version flag to the tool that you'll be able to pass for the mgmt plane cases where you need to compare against the last published preview. Since data-plane will also be using the tool, I'm leaving comparing breaking changes with the last published stable version as the default scenario.

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

Successfully merging a pull request may close this issue.

3 participants