Skip to content

Auto-generate MiMa exclusions via scalafix #503

Open
@armanbilge

Description

@armanbilge

As proposed in #380 (comment).

The idea is to use @japgolly's API report machinery to automatically generate exclusions for known binary-compatible changes for facades as delineated in #461 (comment). This would enable us to use MiMa without the headache of an overwhelming number of false-positives. Furthermore, I think this would be a significant step towards an auto-generation scheme as described in #487 (comment).

I know MiMa exclusions can be specified via files (this is how Akka projects manage theirs) and also in the SBT build. The former strategy is very compatible with the API-report generation scheme, but requires an extra prePR step and CI overhead to keep this in sync with the source. If it's not too ambitious, I wonder if during the MiMa check the exclusions can be generated programmatically instead of read from a (programatically-generated) file. If it works, that would be a significant simplification and remove a burden from both maintenance and contribution.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions