Создание версии для проекта
Как создать версию для Joomla-расширения в компоненте SW JProjects, загрузка архива установочного файла расширения, указание версии Joomla, заполнение списка изменений для данной версии. Настройки SEO.
Что такое версия в SW JProjects?
При развитии проекта (Вашего Joomla расширения) происходит выпуск новых версий с исправлением ошибок, добавлением нового функционала. У каждой версии есть её номер вида 1.0.0. Эта нумерация следует семантическому версионированию (семвер, semver).
Семантическое версионирование (semver)
Принцип семантического версионирования позволяет разработчику осмысленно указывать номер версий так, чтобы его понимали другие разработчики и веб-мастера, работающие с сайтами. А также с помощью семвер можно спланировать и распределить по версиям различные типы изменений в коде, среди которых одно из важнейших место занимает нарушение обратной совместимости - когда новая версия расширения изменилась настолько, что невозможно просто обновить предыдущую версию программы до следующей, но только с помощью миграции и дополнительных действий со стороны пользователя.
Процитируем документацию:
Учитывая номер версии МАЖОРНАЯ.МИНОРНАЯ.ПАТЧ, следует увеличивать:
МАЖОРНУЮ версию, когда сделаны обратно несовместимые изменения API.
МИНОРНУЮ версию, когда вы добавляете новую функциональность, не нарушая обратной совместимости.
ПАТЧ-версию, когда вы делаете обратно совместимые исправления.
Дополнительные обозначения для предрелизных и билд-метаданных возможны как дополнения к МАЖОРНАЯ.МИНОРНАЯ.ПАТЧ формату.
Четвёртый разряд версии в семвер допускается, но не обязателен. Его часто называют hotfix (горячее исправление, быстрая заплатка). Разработчики могут выпускать hotfix версии, когда в выпущенном релизе была допущена какая-то ошибка, требующая немедленного исправления, но часть пользователей уже скачала и начала пользоваться. В таких случаях выпуск версии с заплаткой позволяет обновить программу (Joomla расширение) и при этом не нарушить план релизов (план развития, план выпуска релизов) и не изменять нумерацию версий внутри этого плана.
Первая версия расширения обычно имеет версию 1.0.0.
- Мажорная версия Joomla расширения
- Используется для первой версии и тогда, когда происходят неизбежный слом обратной совместимости. Например, новая версия переписана на новую архитектуру файлов и классов и ранее доступный для Joomla 3 модуль / плагин теперь не может с ней работать, а только с Joomla 4+.
- Минорная версия
- Используется при появлении нового функционала или большого накопленного количества изменений, заметных для конечных пользователей. Например, изменение интерфейса расширения.
- Патч версия
- Используется чаще всего. Любые небольшие изменения, исправления мелких ошибок, рефакторинг кода, поправили комментарий в PHP Doc block, изменили code style и т.д. - это патч версии.
Также можно ознакомиться со стадиями разработки программного обеспечения (Wiki). Это поможет вам сообщить вашим клиентам статус версии для расширения и степень её готовности (alpha, beta, RC...).
Создание версии
Чтобы создать проект, пройдите в меню в панели администратора - Компоненты - SW JProjects - Версии. Нажмите кнопку создать.
Откроется окно для заполнения данных версии. Прежде всего укажите для какого проекта создаётся данная версия. В выпадающем списке проектов работает поиск.
Затем укажите версию и выберите стадию (стабильная, RC, Beta и т.д.). Загрузите установочный файл вашего Joomla расширения.
После того, как вы выбрали проект чуть ниже становится доступно ещё одно поле - версия Joomla. Это минимально необходимая версия Joomla для работы вашего расширения. Указываем цифры, разделенные символом точки - "."
Если вам необходимо заменить загруженный файл - установите чекбокс "Удалить файл" и нажмите "Сохранить". Файл будет удалён и вы сможете загрузить новый.
Список изменений (Changelog)
Для каждой версии желательно заполнять список изменений. Он позволит вам оценивать проделанную работу, а вашим пользователям - узнавать о всех изменениях в новой версии.
Начиная с 4-й линейки в Joomla появилась возможность просматривать список изменений прямо в панели администратора непосредственно перед обновлением расширения. А так же в списке всех установленных расширений.
Согласно документации Adding changelog to your manifest file Joomla предполагает следующие типы изменений:
- исправления уязвимостей (security)
- исправления ошибок (fix)
- локализации - изменения языковых констант, добавление переводов (language)
- новый функционал (addition)
- изменения (change)
- удаления (remove)
- примечания (note)
Заполните список изменений для новой версии.
![Заполнение списка изменений changelog новой версии расширения Joomla в компоненте SW JProjects](/images/development/joomla/components/com_swjprojects/docs/version/7-ru.webp)
Настройки SEO
Обычно страницы версии закрываются от индексации поисковыми системами, так как по сравнению со страницей проекта или документации несут в себе меньше уникальной информации. Но вы можете для каждой версии задать уникальное значение для <title> страницы, meta description, указать изображение для разметки Open Graph.
![Настройки SEO для новой версии расширения Joomla в компоненте SW JProjects](/images/development/joomla/components/com_swjprojects/docs/version/8-ru.webp)