PHPackages voral/bitrix-module-tool - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. voral/bitrix-module-tool ActiveLibrary[Utility & Helpers](/categories/utility) voral/bitrix-module-tool ======================== Extension for vs-version-incrementor to automate building update packages for Bitrix modules. 1.0.1(1y ago)09MITPHPPHP ^8.1CI passing Since May 29Pushed 10mo agoCompare [ Source](https://github.com/Voral/bitrix-module-tool)[ Packagist](https://packagist.org/packages/voral/bitrix-module-tool)[ Docs](https://github.com/Voral/bitrix-module-tool)[ RSS](/packages/voral-bitrix-module-tool/feed)WikiDiscussions master Synced today READMEChangelog (2)Dependencies (6)Versions (3)Used By (0) Сборка пакета обновления модуля Битрикс ======================================= [](#сборка-пакета-обновления-модуля-битрикс) Расширение для пакета [voral/version-increment](https://github.com/Voral/vs-version-incrementor) автоматизирующее пакетов обновления модулей для Битрикс-маркетплейс на основе анализа git коммитов и семантического обновления версии. А так же изменяющее номер версии в файле version.php [![Latest Version on Packagist](https://camo.githubusercontent.com/e44bcf87e62fbdcb1d578737c9e0fe94b935660d57d783a8badf2332bd6c0562/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f766f72616c2f6269747269782d6d6f64756c652d746f6f6c)](https://packagist.org/packages/voral/bitrix-module-tool) Основные функции ---------------- [](#основные-функции) При вычислении новой версии утилитой voral/version-increment перед коммитом выполняются следующие этапы по сборке обновления версии: 1. Изменение версии модуля в соответствии с обновлением в файле install/version.php. А так же даты версии модуля на текущую. Если это файла нет в модуле - он будет создан. 2. На основе анализа коммитов выполненных с предыдущей версии копируются новые и измененные файлы модуля в каталог пакета обновления. Кроме того, при необходимости, добавляется код удаления файлов, которые были удалены из модуля в скрипт обновления `updater.php`> Обратите внимание, что функционал удаления упрощенный - перед окончательным оформлением пакета обновлений рекомендую проверить и скорректировать при необходимости 3. Если в обновление были добавлены каталоги `install/admin`, `install/components` и т.п в скрипт `updater.php` добавляется код по их копированию. При этом для каталога admin выполняется не копирование, а создание файлов которые подключают оригинальные. 4. Если произведена соответствующая настройка в скрипт `updater.php` добавляется проверка версии PHP 5. Если произведена соответствующая настройка в скрипт `updater.php` добавляется дополнительный кастомный PHP код 6. На основе коммитов git выполненных с предыдущей версии формируются файлы description.\* пакета обновлений 7. Если произведена соответствующая настройка генерируется файл контроля версий модулей от которых ваш модуль зависит 8. Файлы `updater.php`, `description.*`, а так же `/install/version.php` (если он был создан) добавляются в репозиторий git Требования ---------- [](#требования) - PHP >= 8.1 - Git установлен и доступен в CLI - Composer для управления зависимостями Подготовка ---------- [](#подготовка) Для начала необходимо установить пакет ``` composer require -dev voral/bitrix-module-tool ``` Если у вас до этого не был установлен пакет [voral/version-increment](https://github.com/Voral/vs-version-incrementor) - он будет установлен и необходимо будет произвести настройку согласно документации. А так же подключить данный пакет в файле `.vs-version-increment.php` ``` use Vasoft\VersionIncrement\Config; use Vasoft\VersionIncrement\Events\EventType; use Voral\BitrixModuleTool\ModuleListener; $config = new Config(); $eventBus = $config->getEventBus(); $listener = new ModuleListener( $config, 'vendor.module', includePhpFile: __DIR__ . '/updates/update_include.php', ); $eventBus->addListener(EventType::BEFORE_VERSION_SET, $listener); // прочие настройки return $config; ``` Т.к., как правило, есть необходимость доработать пакет обновлений перед загрузкой на маркетплейс (например перевести языковые description.\*), рекомендую команду обновления версии выполнять с флагом отключающим коммит ``` php ./vendor/bin/vs-version-increment --no-commit ``` Удобно записать этот скрипт в composer.json. Так же необходимо добавить скрипты создания пакетов модуля (обновления и полного) для загрузки на маркетплейс ``` { "scripts": { "vi:auto": "php ./vendor/bin/vs-version-increment --no-commit", "pack:last": "sh scripts/pack-last.sh", "pack:ver": "sh scripts/pack-version.sh", "pack": [ "@pack:ver", "@pack:last" ] }, "scripts-descriptions": { "vi:auto": "Increment module version and generate update package", "pack:last": "Pack the full package of the module's latest version", "pack:ver": "Pack the update package for a specified module version", "pack": "Pack the full package of the latest version and the update package for a specified version" } } ``` Применение ---------- [](#применение) 1. После выполнения изменений в модуле выполните расчет версии. Ппо окончанию этого скрипта в консоль будут выведены рекомендуемые команды для выполнения коммита и установки тега. Они будут содержать новую версию пакета. ``` composer vi:auto ``` 2. При необходимости внесите изменения в CHANGELOG.md, в так же сгенерированные файлы описания обновления /updates/<версия\_пакета>/description.\* 3. Выполните сборку пакета обновлений для полученной версии (например для версии 1.3.0) ``` composer pack:last 1.3.0 ``` 4. Выполните проверку пакета обновлений как описано в [статье](doc/check_update.md) 5. После всех проверок выполните сборку пакетов обновления и полного пакета модуля ``` composer pack:pack 1.3.0 ``` 6. Выполните коммит релиза и установите так как рекомендовано на шаге 1 7. Загрузить пакет на Битрикс маркетплейс Конфигурация ------------ [](#конфигурация) Настройка выполняется при помощи конструктора, который имеет следующие параметры: **$config** - обязательный. Конфигурация version-increment **$moduleId** - обязательный. Идентификатор вашего модуля **$sourcePath** - необязательный. Каталог с исходниками модуля, относительно корня проекта. По умолчанию `src` **$destinationPath** - необязательный. Каталог для пакетов обновлений, относительно корня проекта. По умолчанию `updates` **$phpVersion** - необязательный. Версия PHP если необходим контроль в скрипте обновления **$modulesVersion** - необязательный. Требующиеся модули и их версии **$excludeCommitTypes** - необязательный. Типы коммитов, сообщения которых необходимо пропускать при формировании файлов description.\* **$lang** - необязательный. Символьные коды языков для создания описания обновлений (файлов description.\*) **$includePhpFile** - необязательный. Путь у php файлу, код которого необходимо включить в скрипт обновления update.php Пример конфигурации ``` use Vasoft\VersionIncrement\Config; use Vasoft\VersionIncrement\Events\EventType; use Voral\BitrixModuleTool\ModuleListener; $config = new Config(); $eventBus = $config->getEventBus(); $listener = new ModuleListener( $config, 'vendor.module', 'last_version', 'marketplace', '8.3.0', [ 'main' => '24.100.100', 'sale' => '24.0.100', ], ['build','docs','test'], ['ru','en','fr'] __DIR__ . '/updates/update_include.php', ); $eventBus->addListener(EventType::BEFORE_VERSION_SET, $listener); // прочие настройки return $config; ``` Исключения генерируемые расширением ----------------------------------- [](#исключения-генерируемые-расширением) КодОписание5101Нет доступа к каталогу проекта5102Не корректный путь к проекту5103Не найден git тег версии5104Отсутствует или не верный формат файла version.php5105Не корректно задан путь к каталогу исходников или обновленийЧтобы избежать конфликты с прочими расширениями пакета voral/vs-version-incrementor можно изменять коды ошибок. Для этого необходимо задать дельту. В приведенном ниже примере коды ошибок будут увеличены на 100 ``` use Vasoft\VersionIncrement\Config; use Vasoft\VersionIncrement\Events\EventType; use Voral\BitrixModuleTool\ModuleListener; use Voral\BitrixModuleTool\Exception\ExtensionException; ExtensionException::$errorCodeDelta = 100; $config = new Config(); $eventBus = $config->getEventBus(); $listener = new ModuleListener($config, 'vendor.module'); $eventBus->addListener(EventType::BEFORE_VERSION_SET, $listener); // прочие настройки return $config; ``` Пример файла install/version.php -------------------------------- [](#пример-файла-installversionphp) ```