Критические изменения

О разделе

Этот раздел документации содержит описание необратимых изменений между версиями продукта. Здесь вы найдёте информацию о:

  • Структурных изменениях (формат данных, схема БД, API)

  • Изменениях в составе (добавленные/удалённые компоненты)

  • Критических изменениях функционала

  • Требованиях к миграциям данных

Перед обновлением обязательно изучите этот раздел для вашей целевой версии.

Типы изменений между версиями

1. Минорные версии (быстрое обновление)

Пример: 0.8.0 → 0.8.1

Характеристики:

  • Обычно содержат исправления ошибок

  • Не требуют сложных миграций данных

  • Часто можно обновляться автоматически

  • Редко содержат критические изменения

Рекомендация: Можно обновлять без длительной подготовки.

2. Мажорные версии (требуют внимания)

Пример: 0.8.0 → 0.9.0

Характеристики:

  • Могут содержать изменения структуры данных

  • Часто требуют ручных миграций

  • Могут изменять поведение системы

  • Иногда добавляют/удаляют компоненты

Рекомендация: Требуют:

  1. Полного изучения изменений

  2. Тестирования на staging-окружении

  3. Планирования времени простоя

Как работать с этим разделом

Для каждой версии существует отдельная страница с описанием:

  1. Критических изменений (что сломается при обновлении)

  2. Изменений в архитектуре (новые/удалённые компоненты)

  3. Миграций данных (какие преобразования необходимы)

  4. Совместимости (требования к окружению)

Подготовка к обновлению с критическими изменениями

  1. Всегда проверяйте наличие раздела «Критические изменения» для целевой версии

  2. Сравнивайте свою текущую версию с целевой через changelog

  3. Особое внимание уделяйте:

    • Изменениям схемы базы данных

    • Модификациям API

    • Обновлениям зависимостей

    • Изменениям в требованиях к инфраструктуре

  4. Проверьте наличие необходимых инструментов миграции

Частые сценарии критических изменений

Изменения в базе данных

  • Переименование таблиц/колонок

  • Изменение типов данных

  • Новые обязательные поля

Изменения в API

  • Удалённые эндпоинты

  • Изменённые форматы запросов/ответов

  • Новые обязательные заголовки

Изменения в составе

  • Удалённые микросервисы

  • Новые обязательные компоненты

  • Изменения в лицензировании модулей

Что делать, если обнаружили проблему?

  1. Проверьте, не описана ли она в разделе «Известные проблемы» для вашей версии

  2. Если обновление уже начато - не пытайтесь откатиться без инструкций

  3. Свяжитесь с поддержкой, предоставив:

    • Версию, с которой обновлялись

    • Версию, на которую обновлялись

    • Точное описание проблемы

    • Соответствующие логи ошибок

Важные предупреждения

  1. Некоторые изменения необратимы - после обновления откат может быть невозможен

  2. Критические изменения могут затрагивать интеграции с другими системами

  3. Время простоя при критических обновлениях может быть значительным

  4. Всегда тестируйте обновление в изолированном окружении перед продакшеном