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

Fail the check if plugin is enabled but no artifacts are set #263

Closed
2m opened this issue Nov 6, 2018 · 3 comments · Fixed by #289
Closed

Fail the check if plugin is enabled but no artifacts are set #263

2m opened this issue Nov 6, 2018 · 3 comments · Fixed by #289
Assignees
Milestone

Comments

@2m
Copy link
Contributor

2m commented Nov 6, 2018

Currently if mimaPreviousArtifacts setting is empty the mimaReportBinaryIssues task succeeds without running any checks. Instead this task should fail with an error message suggesting to set artifacts to check binary compatibility against.

If a sub-module does not wish its BC to be checked, it should disable MiMa autoplugin altogether with .disablePlugins(MimaPlugin).

@dwijnand
Copy link
Collaborator

dwijnand commented Nov 6, 2018

This is a semantic breaking change, but I think it's a good one we should do, with some escape routes.

The first is disabling the plugin. But additionally, given it's not possible to disable a plugin build-wide (indeed you can't make any local build-wide decisions about plugins 😕) I think, for those complex builds out there, we should provide a build-level key that basically reverts this change. An opt-out, basically.

@dwijnand
Copy link
Collaborator

dwijnand commented Nov 6, 2018

In the case of cross-building to a new scala major version (e.g 2.13) today you define mimaPreviousArtifacts to be the empty set when building 2.13, with this change you toggle the key I was describing above.

@dwijnand
Copy link
Collaborator

dwijnand commented Nov 6, 2018

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

Successfully merging a pull request may close this issue.

2 participants