Parse change logs in the style of keepachangelog.com #421
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hi @ifazk, thanks for your PR. Contributions are most definitely welcome! I thought this was somewhat obvious but it is a good point and we should probably create a CONTRIBUTING.md to describe what and how.
As to the PR itself, I wasn't aware of this format before but the changes required to also support that are rather small so I think this is a fine addition. I appreciate that you added tests for it, because otherwise it would be prone to breaking accidentally. I wrote some comments for improving it, so if you could address these I think it is ok to merge.
|
Our CI formatting linter is a bit broken, so I'm merging after checking it locally. Thanks! |
|
Thanks for your help and guidance in getting this merged! |
CHANGES: ### Added - Add `--skip-lint`, `--skip-build`, `--skip-test` and `--keep-build-dir` to the main command (tarides/dune-release#419, @NathanReb) - Added support for parsing changelogs written in the style of [keepachangelog.com](https://keepachangelog.com/) (tarides/dune-release#421, @ifazk)
I recently started using the change log format specified in https://keepachangelog.com. This format uses "Changelog" as the first level of header.
This resulted in
dune-releasetrying to use"Changelog"as the tag. I manually specified the tag, but thendune-releaseused the entire changelog for the pull-request message, see ocaml/opam-repository#20195.This PR changes
Text.change_log_last_entryto recurse intochangesif the header title is "Changelog", and drops brackets around version numbers if there are any.Btw, I wasn't sure if PRs from outsiders are welcome or not and I didn't find a contribution guide. Hope this doesn't feel too aggressive since I didn't open an issue first.