版本控制#

Vega-Altair 历来发布的重大版本与 Vega-Lite 的版本保持一致。

随着项目成熟,以及重大版本发布的频率降低,在这些重大版本之间引入破坏性变更的需求日益增加。此类变更将使 Vega-Altair 能够解决技术债务并改进 API 的易用性。

为了确保未来版本能清晰地传达变更,Vega-Altair 将努力采用 SemVer(语义化版本)。

公共 API#

文档中描述的功能,请参见 API 参考,这定义了 Vega-Altair 的公共 API。

版本号#

Vega-Altair 的版本号由 MAJOR.MINOR.PATCH 组成。

  • 向后不兼容的 API 变更会增加 MAJOR 版本 (4.2.2 - 5.0.0)

  • 新增的向后兼容功能会增加 MINOR 版本 (5.2.0 - 5.3.0)

  • 向后兼容的错误修复会增加 PATCH 版本 (5.1.1 - 5.1.2)

MAJOR 版本可能会随着 Vega-LiteMAJOR 版本增加而增加。

弃用#

弃用警告可能会在 MAJORMINOR 版本中引入,但被弃用的功能不会在至少下一个 MAJOR 版本之前移除。

对于引起 MAJOR 版本变更的上游破坏性变更,如果我们认为此变更具有特别大的影响,我们可能会提供弃用警告。

从版本 5.4.0 开始,所有弃用警告必须说明

  • 引入警告的版本号

如果可能,弃用警告可以说明

  • 可替代的函数/方法/参数/类

  • 进行此更改的原因

被弃用的功能可能会从 Vega-Altair 文档中移除,如果存在合适的替代方案并且我们认为同时保留两者会使新用户感到困惑。