Download the PHP package voral/bitrix-module-tool without Composer
On this page you can find all versions of the php package voral/bitrix-module-tool. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download voral/bitrix-module-tool
More information about voral/bitrix-module-tool
Files in voral/bitrix-module-tool
Package bitrix-module-tool
Short Description Extension for vs-version-incrementor to automate building update packages for Bitrix modules.
License MIT
Homepage https://github.com/Voral/bitrix-module-tool
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package bitrix-module-tool
Сборка пакета обновления модуля Битрикс
Расширение для пакета voral/version-increment автоматизирующее пакетов обновления модулей для Битрикс-маркетплейс на основе анализа git коммитов и семантического обновления версии. А так же изменяющее номер версии в файле version.php
Основные функции
При вычислении новой версии утилитой voral/version-increment перед коммитом выполняются следующие этапы по сборке обновления версии:
- Изменение версии модуля в соответствии с обновлением в файле install/version.php. А так же даты версии модуля на текущую. Если это файла нет в модуле - он будет создан.
- На основе анализа коммитов выполненных с предыдущей версии копируются новые и измененные файлы модуля в каталог пакета обновления. Кроме того, при необходимости, добавляется код удаления файлов, которые были удалены из модуля в скрипт обновления
updater.phpОбратите внимание, что функционал удаления упрощенный - перед окончательным оформлением пакета обновлений рекомендую проверить и скорректировать при необходимости
- Если в обновление были добавлены каталоги
install/admin,install/componentsи т.п в скриптupdater.phpдобавляется код по их копированию. При этом для каталога admin выполняется не копирование, а создание файлов которые подключают оригинальные. - Если произведена соответствующая настройка в скрипт
updater.phpдобавляется проверка версии PHP - Если произведена соответствующая настройка в скрипт
updater.phpдобавляется дополнительный кастомный PHP код - На основе коммитов git выполненных с предыдущей версии формируются файлы description.* пакета обновлений
- Если произведена соответствующая настройка генерируется файл контроля версий модулей от которых ваш модуль зависит
- Файлы
updater.php,description.*, а так же<путь_к_исходникам>/install/version.php(если он был создан) добавляются в репозиторий git
Требования
- PHP >= 8.1
- Git установлен и доступен в CLI
- Composer для управления зависимостями
Как пользоваться
Для начала необходимо установить пакет
Если у вас до этого не был установлен пакет voral/version-increment - он будет установлен и необходимо будет произвести настройку согласно документации. А так же подключить данный пакет в файле .vs-version-increment.php
Т.к., как правило, есть необходимость доработать пакет обновлений перед загрузкой на маркетплейс (например перевести языковые description.*), рекомендую команду обновления версии выполнять с флагом отключающим коммит
Удобно записать этот скрипт в composer.json
После выполнения скрипта произведите необходимую корректировку собранного обновления, упакуйте и загружайте на маркетплейс Битрикс.
Конфигурация
Настройка выполняется при помощи конструктора, который имеет следующие параметры:
$config - обязательный. Конфигурация version-increment
$moduleId - обязательный. Идентификатор вашего модуля
$sourcePath - необязательный. Каталог с исходниками модуля, относительно корня проекта. По умолчанию src
$destinationPath - необязательный. Каталог для пакетов обновлений, относительно корня проекта. По умолчанию updates
$phpVersion - необязательный. Версия PHP если необходим контроль в скрипте обновления
$modulesVersion - необязательный. Требующиеся модули и их версии
$excludeCommitTypes - необязательный. Типы коммитов, сообщения которых необходимо пропускать при формировании файлов description.*
$lang - необязательный. Символьные коды языков для создания описания обновлений (файлов description.*)
$includePhpFile - необязательный. Путь у php файлу, код которого необходимо включить в скрипт обновления update.php
Пример конфигурации
Исключения генерируемые расширением
| Код | Описание |
|---|---|
| 5101 | Нет доступа к каталогу проекта |
| 5102 | Не корректный путь к проекту |
| 5103 | Не найден git тег версии |
| 5104 | Отсутствует или не верный формат файла version.php |
| 5105 | Не корректно задан путь к каталогу исходников или обновлений |
Чтобы избежать конфликты с прочими расширениями пакета voral/vs-version-incrementor можно изменять коды ошибок. Для этого необходимо задать дельту. В приведенном ниже примере коды ошибок будут увеличены на 100
Пример файла install/version.php
Лицензия
MIT License. Подробности в файле LICENSE.
