Automate the commit checks and move the checklist to CONTRIBUTING.md #110
Conversation
We can avoid the dependency on `13rac1/block-fixup-merge-action` because there is a community-contributed `gitlint` rule for it [0]. The `contrib-disallow-cleanup-commits` rule enforces that the subject/title does not contain `fixup!`, `squash!`, or `amend!`. We can also use the `contrib-body-requires-signed-off-by` rule to check that the body contains the `Signed-off-by` line. We decided to move the checklist from the PR template to CONTRIBUTING.md so that contributors don't have to manually tick all checkbox entries for every PR. The CI workflow already runs `cargo check`, `cargo test --all --all-features`, and `cargo clippy --all --all-targets --all-features -- -D warnings`. The `github.event_name == 'pull_request'` check isn't required because of the `on: [pull_request]` statement at the beginning of the file. [0]: https://jorisroovers.com/gitlint/contrib_rules/ Signed-off-by: Michael Weiss <[email protected]>
| gitlint \ | ||
| -c general.ignore-fixup-commits=false \ | ||
| -c general.ignore-fixup-amend-commits=false \ | ||
| -c general.ignore-squash-commits=false \ | ||
| --contrib contrib-body-requires-signed-off-by,contrib-disallow-cleanup-commits \ | ||
| --commits "$(git merge-base origin/master HEAD)..HEAD" |
There was a problem hiding this comment.
I'd rather put a .gitlint file in the repository than using CLI flags, so contributors can run gitlint locally!
There was a problem hiding this comment.
Nice to use gitlint, especially since I contributed that check to gitlint
Haha, nice xD
I'd rather put a .gitlint file in the repository than using CLI flags, so contributors can run gitlint locally!
Yes, I'd also prefer that. If you don't mind, I'd do it in a separate PR though (together with some other gitlint changes/improvements that I didn't include here). This PR already got bigger than expected and I didn't want to squeeze everything into that large commit (and I was also too lazy to repeat all of my tests for it tbh).
There was a problem hiding this comment.
Bigger than expected with one commit? Hahah you clearly haven't seen my 800+ commit PRs yet.
But sure, go ahead! I'm not the maintainer here, so I have nothing to say anyways! 😆
There was a problem hiding this comment.
@matthiasbeyer You know that's not true and your opinion matters here :)
@primeos-work Thanks for the PR
bors merge
|
Build succeeded: |
We can avoid the dependency on
13rac1/block-fixup-merge-actionbecause there is a community-contributedgitlintrule for it 0. Thecontrib-disallow-cleanup-commitsrule enforces that the subject/title does not containfixup!,squash!, oramend!. We can also use thecontrib-body-requires-signed-off-byrule to check that the body contains theSigned-off-byline.We decided to move the checklist from the PR template to CONTRIBUTING.md so that contributors don't have to manually tick all checkbox entries for every PR.
The CI workflow already runs
cargo check,cargo test --all --all-features, andcargo clippy --all --all-targets --all-features -- -D warnings.The
github.event_name == 'pull_request'check isn't required because of theon: [pull_request]statement at the beginning of the file.Signed-off-by: Michael Weiss [email protected]
Tested via my fork: