正在检测版本的向后不兼容的API更改

Detecting backwards incompatible API changes for releases

本文关键字:不兼容 API 更改 检测 版本      更新时间:2023-09-26

我管理着一个由数百人开发的开源JS库。是否有一种简单、自动化的方法来确定一个特定的标记版本是否有向后不兼容的API更改?我看到了类似的Java,Java API法规遵从性检查器。

关于代码库的更多细节:我们有代码库的内部版本和外部版本。我们只是偶尔将内部版本"翻墙"推送到GitHub。在这一点上,我们想确定新创建的外部版本是否有可能破坏用户的API更改。

是的,我们可以要求开发人员注意他们是否检查了向后不兼容的更改,但这很容易出错,如果是自动化的话会更好。

我认为最简单的方法是使用单元测试。您编写测试以了解您期望API如何工作。如果您的API以不兼容的方式更改,那么您的测试将中断,并且您知道更改是向后不兼容的。