Download the PHP package churchtools/changelogger without Composer
On this page you can find all versions of the php package churchtools/changelogger. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download churchtools/changelogger
More information about churchtools/changelogger
Files in churchtools/changelogger
Package changelogger
Short Description CLI Tool for creating consistent and committable changelog entries.
License Apache-2.0
Homepage https://github.com/churchtools/changelogger
Informations about the package changelogger
Changelogger
Changeloggger is a CLI tool to help you create better changelogs
At ChurchTools we develop a SaaS. To keep our users informed, we write changelogs for every version. We used to add our changelogs to the issue, but many times we forgot to add the changelog—and manual copy 'n' paste is tedious work! This tool helps us to write and create consistent changelogs that are committable so the reviewer can check it before merging.
What does it do?
Changelogger saves each log entry as a YAML file in changelogs/unreleased
. During the development process many files from different features, bug fixes, and so on find their way into this folder.
We create for each change a different file to easily track them. Adding them to a single file, like Changelog.md
directly could lead to nasty merge conflicts. One file per change avoids that.
In the end, if a new version is built, Changelogger takes all unreleased changes, sorts them and adds a new release to CHANGELOG.md
. After that all files in changelogs/unreleased
are deleted and your project is ready for the next version.
Changelogger is not taking your git-logs. There exists many tools that take your git-log and converts commit messages to changelog entries. IMHO, this leads in many cases to bad changelogs. Commit messages are not changelogs. They are pieces of information for developers and not the users. Our changelogs are handcrafted because non-developers, AKA our users, should be able to understand the changes.
Installation
This package requires PHP 8.1 You can require the package as a dev-dependency
or install it globally.
Usage
License
churchtools/changelogger is licensed under the Apache License 2.0