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.

Sign up for GitHub

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

Jump to bottom

Segregate reporting of internal breaking changes #140

Open
hamsbrar opened this issue Jun 5, 2023 · 2 comments
Open

Segregate reporting of internal breaking changes #140

hamsbrar opened this issue Jun 5, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@hamsbrar
Copy link
Contributor

hamsbrar commented Jun 5, 2023

Hi! thanks for this awesome tool!

Is your feature request related to a problem? Please describe.

It seems that the package considers the removal of internal APIs(@internal) as breaking changes. It is my understanding that internal APIs are not intended for public use and can change without notice so treating their removal as major breaking changes might not be accurate.

Describe the solution you'd like

  • One solution would be to add a CLI option to allow users to opt in for checking internal breaking changes.
  • (Or) Report internal changes under a separate category("Internal Breaking Changes").
@hamsbrar hamsbrar added the enhancement New feature or request label Jun 5, 2023
@devmil
Copy link
Member

devmil commented Jun 7, 2023 •
edited
Loading

Hi.
Nice idea. I think it would be best to just support the "internal" annotation just like dart_apitool already supports the "sealed" and "experimental" annotations. 👍

@hamsbrar
Copy link
Contributor Author

hamsbrar commented Jun 7, 2023

Yea, that'll be good too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Milestone
No milestone
Development

No branches or pull requests
2 participants
@devmil @hamsbrar