search

churchtools / changelogger

CLI Tool for creating consistent and committable changelog entries.
https://churchtools.github.io/changelogger/
Apache License 2.0
32 stars 9 forks source link

Handling of legacy CHANGELOG.md files #28

Open DennisDobslaf opened 4 years ago

DennisDobslaf commented 4 years ago

I used this tool on a repo with an existing but old CHANGELOG.md file with no common schema. This tool doesn't write to may legacy CHANGELOG.md on changelogger release but deletes the unreleased files.

DennisDobslaf commented 4 years ago

Self-answering my question:

here is the reason: https://github.com/churchtools/changelogger/blob/master/app/Commands/ReleaseCommand.php#L103

As a workaround one can insert <!-- CHANGELOGGER --> at the top of a legacy CHANGELOG.md file.

obstschale commented 4 years ago

Yes, the tool looks for <!-- CHANGELOGGER --> and uses this as placeholder. I will document this. Thx for pointing this out.

strausmann commented 3 years ago

Thanks for the tip, i had the same problem.