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

Guidance or Ideas on support ignoring certain classes of changes #546

Open
kbendick opened this issue May 31, 2022 · 2 comments
Open

Guidance or Ideas on support ignoring certain classes of changes #546

kbendick opened this issue May 31, 2022 · 2 comments

Comments

@kbendick
Copy link

What happened?

Feature request / tool usage assistance!

What did you want to happen?

The Revapi project defines a way to ignore certain types of changes, for example, adding a method to an interface is called out in the docs (though that way of using the maven plugin is apparently deprecated but the idea remains the same)

We’ve begun using gradle-revapi in the Apache Iceberg project, and we’d very much like to suppress BREAKS for “method added to interface”, as the way we use the project / perform releases, we don’t generally expect it to be a problem.

Is it possible to ignore certain types of “breaking” changes now with the existing gradle revapi package? I didn’t see anything, so this is partially a feature request.

I’m somewhat new to revapi myself so it’s possible this is already achievable and I just don’t have my configuration files correctly. But this does appear to be possible with the maven revapi plugin.

Thank you for this wonderful plug-in!

@kbendick
Copy link
Author

For reference, this is our .revapi file in the Apache Iceberg project https://github.com/apache/iceberg/blob/master/.palantir/revapi.yml.

The plug-in is applied to one sub module iceberg-api, in our build.gradle file with everything very standard / common setup.

@kbendick kbendick changed the title How to support ignoring certain classes of changes Guidance or Ideas on support ignoring certain classes of changes Jun 12, 2022
@kbendick
Copy link
Author

I'd be open to try helping with this PR if possible (to add a whitelist / ignore list to the revapi file configuration for certain classes).

Please let me know if that's something you'd be open to or not or if hopefully it's already possible 👍

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

No branches or pull requests

1 participant