PHPackages hiddenpathz/changelog-writer - 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. hiddenpathz/changelog-writer ActiveLibrary[Utility & Helpers](/categories/utility) hiddenpathz/changelog-writer ============================ Автоматический генератор файла CHANGELOG.md 1.4.4(1y ago)7751MITPHPPHP >=7.3 Since Apr 24Pushed 1y ago1 watchersCompare [ Source](https://github.com/hiddenpathz/changelog-writer)[ Packagist](https://packagist.org/packages/hiddenpathz/changelog-writer)[ RSS](/packages/hiddenpathz-changelog-writer/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)DependenciesVersions (23)Used By (1) ChangeLog Writer ================ [](#changelog-writer) ChangeLog Writer - это инструмент, который позволяет автоматически генерировать файл Changelog в вашем проекте. Требования к окружению ---------------------- [](#требования-к-окружению) Для работы ChangeLog Writer требуется PHP версии 7.3.0 и выше. В приложении: Контроль версий GIT ветки Develop и Master Файл CHANGELOG.md в корне Установка --------- [](#установка) Для начала работы с ChangeLog Writer выполните следующие шаги: 1. Установите пакет с помощью Composer: ``` composer global require hiddenpathz/changelog-writer ``` 2. Добавим ссылку в систему Для Linux ``` sudo ln -s ~/.config/composer/vendor/hiddenpathz/changelog-writer/src/bin /usr/bin/changeloger ``` Для MacOS ``` sudo ln -s ~/.composer/vendor/hiddenpathz/changelog-writer/src/bin /usr/local/bin/changeloger ``` 3. Changeloger готов к работе. Находясь в папке своего проекта достаточно вызвать его по ссылке которую создали. Подготовка проекта для работы ----------------------------- [](#подготовка-проекта-для-работы) Добавьте в свой ENV файл - переменную с ссылкой на ваш репозиторий до номера тега - префикс ветки (опционально, зависит от правил): - Название системы поставщика задач (опционально, зависит от правил, если нужно чтобы в ченжлоге были ссылки на задачи): - Ссылку на систему поставщика задач до кода заявки (опционально, зависит от правил, если нужно чтобы в ченжлоге были ссылки на задачи): ``` REPOSITORY_LINK=https://gitlab.some.ru/your.repo.ru//-/tags/ BRANCH_PREFIX=MYPROJECT TASK_SYSTEM_NAME=SomeTaskSystemName TASK_SYSTEM_LINK=https://some-task-system.ru/tasks/view?code= ``` - Если файл CHANGELOG.md находится на разных уровнях с файлом .env, необходимо выполнять команду в каталоге с .env, а также добавить переменную: ``` CHANGELOG_PATH=../CHANGELOG.md ``` Ваша консольная команда для запуска ChangeLog Writer выглядит следующим образом: ``` changeloger changeloger https://gitlab.some.ru/your.repo.ru//-/tags/ ``` В случае указания пути в атрибуте, именно он будет использован в файле. Использование ------------- [](#использование) - При старте вы будете автоматически переключены на ветку develop. - Программа запросит ввести номер заявки и задачи, для именования ветки в формате IU000000-W0111111. - От нее создастся ветка вида: "feature/MYPROJECT-IU000000-W0111111-assign-to-changelog" (Если в env указан префикс) "feature/IU000000-W0111111-assign-to-changelog" (Если в env не указан префикс) - Далее выведется текущая версия приложения: ``` Текущая версия приложения: 1.24.5 Какую версию нужно поднять? 1 - major (*.0.0) 2 - minor (0.*.0) 3 - fix (0.0.*) ``` - После выбора следующей версии приложения скрипт выведет все коммиты подходящие под правила именования. Удостоверьтесь, что ваш коммиты содержат ключевые слова в сообщении, для того чтобы они были отображены в файле Changelog. КлючЗаписьfeatРеализованоrefactorИзмененоfixИсправленоremoveУдаленоОбработка включает ключи, которые не будут отображены в CHANGELOG.md ``` wip - (work in process) - для промежуточных коммитов в процессе работы ci - Коммиты с настройками CI/CD build - Коммиты с настройками окружения, которые не несут смысловой нагрузки для юзеров и не должны отображаться в описании изменений ``` - Пример коммита который попадет в changelog. ``` refactor: Rewrite order method ``` - Если добавить переменные для поставщика задач `TASK_SYSTEM_NAME` и `TASK_SYSTEM_LINK`. ``` refactor: Rewrite order method [Заявка SomeTaskSystemName](https://some-task-system.ru/tasks/view?code=IU000000) ``` Пример результата ----------------- [](#пример-результата) ``` # История изменений ## [ [1.1.0](https://gitlab.some.ru/your.repo.ru//-/tags/1.1.0) ] - 01.01.2023 - Реализовано: - Установлена версия РНР до 8.2 - Добавлен пакет Redis - Изменено: - Переписан метод получения заказа ``` Завершение работы ----------------- [](#завершение-работы) - Когда скрипт закончит работу и файл будет заполнен, он предложит создать коммит - Если нажать Y то коммит создастся и ветка зальется в репозиторий, а локально удалится - Если N, действия эти нужно будет делать вручную - Далее останется только перейти в репозиторий и создав MR перенести изменения на develop - А потом также через MR перенести изменения на master Лицензия -------- [](#лицензия) ChangeLog Writer выпущен под лицензией MIT. Подробную информацию можно найти в файле LICENSE в корневой директории проекта. ### Health Score 32 — LowBetter than 72% of packages Maintenance46 Moderate activity, may be stable Popularity16 Limited adoption so far Community9 Small or concentrated contributor base Maturity49 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~39 days Recently: every ~0 days Total 19 Last Release 419d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/c6f4a840eb3c533929e36c10bfe4c7588817059d6a5e43dc04ff2590bd8ac2a3?d=identicon)[hiddenpathz](/maintainers/hiddenpathz) --- Top Contributors [![hiddenpathz](https://avatars.githubusercontent.com/u/43404501?v=4)](https://github.com/hiddenpathz "hiddenpathz (25 commits)") ### Embed Badge ![Health badge](/badges/hiddenpathz-changelog-writer/health.svg) ``` [![Health](https://phpackages.com/badges/hiddenpathz-changelog-writer/health.svg)](https://phpackages.com/packages/hiddenpathz-changelog-writer) ``` ### Alternatives [uuf6429/rune PHP Rule Engine. 7011.8k](/packages/uuf6429-rune) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)