-
Notifications
You must be signed in to change notification settings - Fork 15
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
Add ability to ignore packages #35
Comments
By passing the `--ignore` flag to go-apidiff it is now possible to ignore incompatible changes in a list of packages. This flag can be specified multiple times. This is passed via the `ignore-list` input parameter in the github action and must be specified as a comma-separated list. Fixes joelanford#35
I'm not sure this is something we should support or encourage (see #14 (comment)). I would recommend moving test utilities to an internal tree if you do not want users of your library to use them. |
I understand that the From my point of view, it's still useful to allow users to ignore specific paths. |
It is more than a convention. Dave Cheney has a succinct blog post about it here: https://dave.cheney.net/2019/10/06/use-internal-packages-to-reduce-your-public-api-surface TL;DR: As such, any breaking change in a non-internal package is, by definition, a breaking change to the API surface of the go module. The goal of go-apidiff is to report on whether a change could have the potential to break any importers of the changed packages.
What is holding folks back from adopting use of |
@joelanford what about this use case: kubernetes-sigs/cluster-api-provider-openstack#2096 v1beta1 package is stable, but not v1alpha1. I still want to run apidiff against v1beta1. |
It could be useful to allow user to specify a list of packages to ignore when checking for API compatibility, when one does not care about a subset of packages such as tests.
The text was updated successfully, but these errors were encountered: