Допустим, вы внесли изменения в своё приложение, плагин, виджет или тему дизайна и собираетесь опубликовать новую версию для пользователей.
Как это правильно сделать, чтобы обновление работало корректно:
- Увеличьте номер версии в конфигурационном файле продукта:
app.php
— для приложений;plugin.php
— для плагинов;widget.php
— для виджетов;theme.xml
— для тем дизайна.
Общепринятый принцип выбора номера очередной версии:
- если только были исправлены ошибки и сделаны непринципиальные улучшения, то повышается 3-я часть номера версии, например, с
1.0.0
до1.0.1
; - если были добавлены новые возможности или сделаны значительные улучшения, то повышается 2-я часть номера версии, например, с
1.0.0
до1.1.0
; - если переработана значительная часть исходного кода продукта, то повышается 1-я часть номера версии, например, с
1.0.0
до2.0.0
.
- Для приложений, плагинов и виджетов: добавьте файлы метаобновлений (подробнее) в следующих случаях:
- В новой версии отсутствуют файлы, которые содержались в предыдущей версии, — для того чтобы оставшиеся на сервере пользователя файлы старых версий не мешали работе обновлённого кода.
- В новой версии используется другая другая структура хранения данных, используемых вашим продуктом, — для того чтобы работа обновлённого кода не нарушилась в установках тех пользователей, которые успели сохранить данные с использованием старой логики.
- Новая версия использует таблицы или поля таблиц, которые не использовала предыдущая версия. Даже если вы описали новые таблицы и поля в файле
db.php
, они автоматически не появятся в аккаунтах при обновлении до новой версии. Файлdb.php
срабатывает только при установке продукта, но не при его обновлении.
- Для продуктов, использующих файлы локализации gettext: обновите файлы локализации:
- Сгенерируйте обновлённую версию файла локализации с помощью консольной команды и добавьте перевод для новых ключей.
- Удалите из файла неиспользуемые ключи локализации — их можно увидеть с использованием этой же консольной команды, выполненной с аргументом
--debug
. - Сохраните файл с расширением
.po
в приложении Poedit — это действие сгенерирует обновлённую версию бинарного файла с расширением.mo
.
- Проверьте установку обновления в тестовом окружении:
- Установите в тестовый аккаунт предыдущую версию продукта и воспроизведите с ним различные действия пользователей, чтобы изменились стандартная конфигурация и пользовательские настройки. Либо не выполняйте никаких действий, чтобы проверить случай, когда пользователь установил ваш продукт, но не выполнял с ним никаких действий вплоть до установки данного обновления.
- Скопируйте в этот же аккаунт файлы новой версии с перезаписью всех старых файлов новыми.
- Очистите кеш в приложении «Настройки».
- Проверьте работу новой версии в этом аккаунте.
- В случае обнаружения ошибок исправьте их в исходных файлах новой версии и повторите процедуру тестирования до достижения наилучшего результата.
- Обновите описания, изображения и инструкции по использованию продукта, доступные в магазине Webasyst и на вашем сайте.