Нумерация версий
Исторически основные версии Vega-Altair выпускались одновременно с соответствующими основными версиями Vega-Lite.
По мере развития проектов основные выпуски стали реже, а потребность во введении несовместимых изменений между ними возросла. Такие изменения позволяют сокращать технический долг и улучшать удобство 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-Lite.
Устаревание функциональности
Предупреждения об устаревании могут появляться в выпусках MAJOR и MINOR, но удаление устаревшей функциональности произойдёт не раньше следующего MAJOR.
Если несовместимое изменение в зависимостях вызывает выпуск MAJOR, авторы могут выдать предупреждение об устаревании, если считают изменение особенно существенным для пользователей.
Начиная с 5.4.0, каждое предупреждение об устаревании обязательно указывает:
- Версию, в которой оно впервые появилось.
По возможности предупреждение может также указывать:
- Функцию, метод, параметр или класс для замены.
- Объяснение необходимости изменения.
Устаревшая функциональность может удаляться из документации Vega-Altair, если есть подходящая замена и одновременное описание обоих вариантов может запутать новых пользователей.