Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

scriv collect should check category names #111

Open
SpecLad opened this issue Oct 13, 2023 · 2 comments
Open

scriv collect should check category names #111

SpecLad opened this issue Oct 13, 2023 · 2 comments

Comments

@SpecLad
Copy link

SpecLad commented Oct 13, 2023

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
Copy link
Contributor

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
Copy link
Author

SpecLad commented Oct 25, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants