Download the PHP package hiddenpathz/changelog-writer without Composer
On this page you can find all versions of the php package hiddenpathz/changelog-writer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download hiddenpathz/changelog-writer
More information about hiddenpathz/changelog-writer
Files in hiddenpathz/changelog-writer
Package changelog-writer
Short Description Автоматический генератор файла CHANGELOG.md
License MIT
Informations about the package changelog-writer
ChangeLog Writer
ChangeLog Writer - это инструмент, который позволяет автоматически генерировать файл Changelog в вашем проекте.
Требования к окружению
Для работы ChangeLog Writer требуется PHP версии 7.3.0 и выше.
В приложении:
Контроль версий GIT ветки Develop и Master Файл CHANGELOG.md в корне
Установка
Для начала работы с ChangeLog Writer выполните следующие шаги:
-
Установите пакет с помощью Composer:
-
Добавим ссылку в систему
Для Linux
Для MacOS
- Changeloger готов к работе. Находясь в папке своего проекта достаточно вызвать его по ссылке которую создали.
Подготовка проекта для работы
Добавьте в свой ENV файл
- переменную с ссылкой на ваш репозиторий до номера тега
- префикс ветки (опционально, зависит от правил):
- Название системы поставщика задач (опционально, зависит от правил, если нужно чтобы в ченжлоге были ссылки на задачи):
-
Ссылку на систему поставщика задач до кода заявки (опционально, зависит от правил, если нужно чтобы в ченжлоге были ссылки на задачи):
- Если файл CHANGELOG.md находится на разных уровнях с файлом .env, необходимо выполнять команду в каталоге с .env, а также добавить переменную:
Ваша консольная команда для запуска ChangeLog Writer выглядит следующим образом:
В случае указания пути в атрибуте, именно он будет использован в файле.
Использование
-
При старте вы будете автоматически переключены на ветку develop.
-
Программа запросит ввести номер заявки и задачи, для именования ветки в формате IU000000-W0111111.
-
От нее создастся ветка вида: "feature/MYPROJECT-IU000000-W0111111-assign-to-changelog" (Если в env указан префикс) "feature/IU000000-W0111111-assign-to-changelog" (Если в env не указан префикс)
-
Далее выведется текущая версия приложения:
- После выбора следующей версии приложения скрипт выведет все коммиты подходящие под правила именования.
Удостоверьтесь, что ваш коммиты содержат ключевые слова в сообщении, для того чтобы они были отображены в файле Changelog.
Ключ | Запись |
---|---|
feat | Реализовано |
refactor | Изменено |
fix | Исправлено |
remove | Удалено |
Обработка включает ключи, которые не будут отображены в CHANGELOG.md
-
Пример коммита который попадет в changelog.
- Если добавить переменные для поставщика задач
TASK_SYSTEM_NAME
иTASK_SYSTEM_LINK
.
Пример результата
Завершение работы
- Когда скрипт закончит работу и файл будет заполнен, он предложит создать коммит
- Если нажать Y то коммит создастся и ветка зальется в репозиторий, а локально удалится
- Если N, действия эти нужно будет делать вручную
- Далее останется только перейти в репозиторий и создав MR перенести изменения на develop
- А потом также через MR перенести изменения на master
Лицензия
ChangeLog Writer выпущен под лицензией MIT. Подробную информацию можно найти в файле LICENSE в корневой директории проекта.
All versions of changelog-writer with dependencies
ext-readline Version *