Changelog.sh is a tool to keep a changelog without conflicts. It supports rendering your changelog into a standard keepachangelog format.
Maintaining a CHANGELOG.md is annoying because it's prone to merge conflict. Multiple developer adding line to a single file will confuse git as to which change should go first.
The solution is to create a file for each changelog entry that can be commited to git. This strategy avoid merge conflicts when multiple developers add a changelog entry.
Having a changelog
directory looking like this:
changelog/
2.0.1/
added/
20180406201409
fixed/
20180406202703
20180411092409
2.0.0/
changed/
20180322144612
1.1.0/
added/
20180402183256
1.0.0/
added/
20180405192450
would yield a CHANGELOG.md that would like like this:
## [2.0.1]
### Added
- Never gonna give you up
### Fixed
- [123] Never gonna let you down
- [124] Never gonna run around and desert you
## [2.0.0]
### Changed
- Never gonna make you cry
## [1.1.0]
### Added
- Never gonna say good bye
## [1.0.0]
### Added
- Never gonna tell a lie and hurt you
Changelog.sh is installed by running one of the following commands in your terminal. You can install this via the command-line with either curl
or wget
.
sh -c "$(curl -fsSL https://raw.githubusercontent.com/whitecloakph/changelog-sh/master/tools/install.sh)"
sh -c "$(wget https://raw.githubusercontent.com/whitecloakph/changelog-sh/master/tools/install.sh)"
change init
change new {type_of_change} {message}
change preview
change release {version}