Breaking-good

Overview

Breaking-Good is a tool that provides explanations for breaking dependency updates. It uses build analysis to identify the root cause of the breaking changes and provides a detailed explanation to help developers understand and fix the problem.

if you use Breaking-Good, please cite:

@article{reyes2024breaking,
  title={Breaking-Good: Explaining Breaking Dependency Updates with Build Analysis},
  author={Reyes, Frank and Baudry, Benoit and Monperrus, Martin},
  journal={arXiv preprint arXiv:2407.03880},
  year={2024}
}

How to use Breaking-Good

To use Breaking-Good, you need to provide the following inputs:

• The previous version of the dependency
• The new version of the dependency
• (Optional) The logs generated in the build process

You can build this tool locally using mvn package with Java 17. You can then run the tool and print usage information with the command:

java -jar target/Explaining.jar explaining --help 

License

Distributed under the MIT License. See LICENSE for more information.