Версии и изменения
Docara нумерует версии по правилам семантического
версионирования: major.minor.patch,
например 3.10.0.
| Часть номера | Что меняется | Нужно ли менять проект |
|---|---|---|
patch: 3.10.0 → 3.10.1 |
Исправления ошибок | Нет |
minor: 3.9 → 3.10 |
Новые компоненты, параметры и команды; старые имена продолжают работать с предупреждением | Нет; предупреждения стоит исправить до следующей minor-версии |
major: 2.x → 3.0 |
Изменения, несовместимые с прежними проектами | Да, по инструкции перехода |
Коды ошибок не меняются между версиями, поэтому найденное по коду решение остаётся верным и после обновления.
Журнал изменений
Все изменения каждой версии записаны в CHANGELOG.md в репозитории Docara — на английском, по разделам «Added» (добавлено), «Changed» (изменено), «Fixed» (исправлено) и «Deprecated» (устарело). Тот же текст публикуется в описании выпуска на странице Releases. Раздел «Unreleased» наверху журнала — то, что войдёт в следующую версию.
Какая версия стоит в вашем проекте, показывают composer.lock и команда:
composer show simai/docara
Устаревшие имена
Когда имя параметра или значение заменяют, старое продолжает работать до
следующей minor-версии. Сборка не останавливается, а сообщает одной строкой,
сколько старых имён осталось; docara validate page <адрес> показывает
каждое место с заменой (код MARKDOWN_PARAMETER_DEPRECATED). Список замен —
в разделе «Устаревшие имена параметров».
Перед обновлением на новую minor-версию проверьте, что предупреждений не осталось:
php vendor/bin/docara build production
Как обновиться
Внутри одной major-версии обновление выполняет команда docara upgrade: она
выбирает новую версию, собирает и проверяет сайт на копии проекта и меняет
файлы только после успешной проверки. Переход на новую major-версию
выполняется вручную. Оба пути описаны на странице
«Обновление Docara».