-
Notifications
You must be signed in to change notification settings - Fork 21
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
CI: Add PR title checker #1087
CI: Add PR title checker #1087
Conversation
Loosely adapted the workflow from what we have in neondatabase/cloud, but with the format changed to match what we've previously done in this repo.
Meant to include this; forgot!
Broadly looks good and I really like the idea. What do you think if we extract shell script from yaml to a separate files under |
Hm, looks like we'd need a Would be good to discuss? |
I mostly used reference to pre commit as an example why to extract script to external file. though if we look on your point: pre commit hooks are skippable and the tool I mentioned is optional. E.g even you have config for it in the repo, you still need explicitly turn it on. |
Planning to merge as-is, but we should discuss a pre-commit hook or something after :) |
Loosely adapted the workflow from what we have in neondatabase/cloud, but with the format changed to match what we've previously done in this repo.
As currently implemented, PR titles would generally be required to look like:
or, at its most flexible:
There's two escape hatches:
Revert: "
<!-- affects all -->
in the PR body — in case your PR is more broadSome context:
It's better to have something automated require this, so this PR adds that.
Notes for review: This PR is mostly for discussion! We can change the existing convention if we want :)
I do think that enforcing a common format is valuable regardless, even if it's not the particular implementation initially used in this PR.