nedbat / scriv

Changelog management tool
https://scriv.readthedocs.io
Apache License 2.0
256 stars 28 forks source link

`scriv collect` should check category names #111

Open SpecLad opened 11 months ago

SpecLad commented 11 months ago

Currently it seems that scriv doesn't care if the headers in the changelog fragments match the configured category names. So if I make a typo and write e.g. "### Secruity", scriv will just assume that it's a category of its own.

It would be useful if scriv were to error out when encountering such fragments.

kurtmckee commented 11 months ago

Would it be helpful for such a check to be a pre-commit hook, so that developers can catch this at PR submission, rather than when they're trying to cut a release?

SpecLad commented 11 months ago

I think it should be part of scriv collect, but this subcommand could have a --dry-run/--check option, which would then be usable as a pre-commit hook.