BreakBot: Analyzing the Impact of Breaking Changes to Assist Library Evolution
arXiv:2111.05132 · doi:10.1145/3510455.3512783
Abstract
"If we make this change to our code, how will it impact our clients?" It is difficult for library maintainers to answer this simple-yet essential!-question when evolving their libraries. Library maintainers are constantly balancing between two opposing positions: make changes at the risk of breaking some of their clients, or avoid changes and maintain compatibility at the cost of immobility and growing technical debt. We argue that the lack of objective usage data and tool support leaves maintainers with their own subjective perception of their community to make these decisions. We introduce BreakBot, a bot that analyses the pull requests of Java libraries on GitHub to identify the breaking changes they introduce and their impact on client projects. Through static analysis of libraries and clients, it extracts and summarizes objective data that enrich the code review process by providing maintainers with the appropriate information to decide whether-and how-changes should be accepted, directly in the pull requests.
arXiv comment44th IEEE/ACM International Conference on Software Engineering: New Ideas and Emerging Results, ICSE (NIER) 2022, May 2022, Pittsburgh, United States
References in corpus (6)
- Lags in the Release, Adoption, and Propagation of npm Vulnerability Fixes
- Dependency Smells in JavaScript Projects
- Why and How Java Developers Break APIs
- Automatic Test Improvement with DSpot: a Study with Ten Mature Open-Source Projects
- API Beauty is in the eye of the Clients: 2.2 Million Maven Dependencies reveal the Spectrum of Client-API Usages
- Extending the team with a project-specific bot