ci(pre-commit): add gitlint

[BreadGenie]

• fix ci: Enforce conventional commit message format in commits #1563

[BreadGenie]

Running of gitlint in CI is not via pre-commit (due to the hook type being commit-msg). I've used a workaround to get it working in our CI.

[Molkree]

git log -1 --pretty=%B | gitlint`

This will only check the last commit, right? What if someone pushes more at once? We need to run on the range of commits in PR.

I feel like the effort/usefulness ratio of properly setting up a CI for this is not great. Every new contrib is gonna trigger this check :)

[codecov-commenter]

Codecov Report

Merging #1573 (80f4e51) into main (62ae407) will decrease coverage by 0.04%.
The diff coverage is 53.84%.

@@            Coverage Diff             @@
##             main    #1573      +/-   ##
==========================================
- Coverage   80.36%   80.31%   -0.05%     
==========================================
  Files         281      281              
  Lines        5581     5588       +7     
  Branches      913      916       +3     
==========================================
+ Hits         4485     4488       +3     
- Misses        897      899       +2     
- Partials      199      201       +2     

Flag	Coverage Δ
longtests	80.31% <53.84%> (-0.05%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
cve_bin_tool/cli.py	70.79% <33.33%> (-0.64%)	⬇️
cve_bin_tool/version_scanner.py	56.86% <50.00%> (+0.42%)	⬆️
test/test_checkers.py	93.54% <66.66%> (-3.07%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8d95852...80f4e51. Read the comment docs.

[BreadGenie]

The command for gitlint seems to be not working in our CI. gitlint is using git rev-list <--commits' argument> under the hood and it seems like git can't detect the main or current feature branches. Tried the same with range of commits.

[BreadGenie]

The same code works on my fork (failing conventional commit check and passing check) but not here 🤔. Weird.

[Molkree]

@BreadGenie, what you did doesn't work because this repo doesn't have the new branch so you can't just do origin\branch-from-fork. You were pretty close in your attempts, you have used exact commits before but it didn't work because checkout Action only gets the last commit by default, then you changed it to checkout all commits but at the same time changed commit range to use (wrong) refs instead (and also modified what commit to checkout later).

So what you need to do is checkout more commits (can just leave 0 to checkout all history but maybe 50/100 would be enough) and use exact commits for the range.

Look at the last commit here #1578

[BreadGenie]

Thanks a lot for the explanation. Good to know that I was closer to what we intended to do. :D

[terriko]

Is this working as expected and ready to merge? I can't quite tell from the comments what state we're in.

[BreadGenie]

The commit message test for 3e9b00d failed. So it is working as intended.

[terriko]

Okay, let's give this a shot then! Thanks for all the investigation @BreadGenie and @Molkree