Add GH Action for commit message validation. #4167
Conversation
OhmSpectator
force-pushed
the
feature/commitlint
branch
8 times, most recently
from
cfe9550 to
2c5cbfe
Compare
OhmSpectator
changed the title
OhmSpectator
force-pushed
the
feature/commitlint
branch
3 times, most recently
from
265bc19 to
eb51f66
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4167 +/- ##
=======================================
Coverage 19.69% 19.69%
=======================================
Files 8 8
Lines 2600 2600
=======================================
Hits 512 512
Misses 1985 1985
Partials 103 103 ☔ View full report in Codecov by Sentry. |
OhmSpectator
force-pushed
the
feature/commitlint
branch
from
eb51f66 to
147257a
Compare
OhmSpectator
force-pushed
the
feature/commitlint
branch
13 times, most recently
from
6de71a0 to
70278ea
Compare
OhmSpectator
changed the title
| recommended format. The recommended format is as follows: | ||
| * Commit message should have a subject and body | ||
| * An empty line should separate the subject and body | ||
| * The body should not be empty (it should contain more than just "Signed-off-by") |
There was a problem hiding this comment.
Should we also impose line length limit?
There was a problem hiding this comment.
I thought about it, but we have too many people for whom even these rules can be too strict =D So, let's introduce the restrictions step by step.
| repo = git.Repo(search_parent_directories=True) | ||
|
|
||
| # Fetch the latest from origin/master to ensure we are comparing correctly | ||
| repo.remotes.origin.fetch('master') |
There was a problem hiding this comment.
Same suggestion as posted here: https://github.com/lf-edge/eve/pull/4166/files#r1732333183
There was a problem hiding this comment.
Yep, will have to fix it.
| # Fetch the latest from origin/master to ensure we are comparing correctly | ||
| repo.remotes.origin.fetch('master') | ||
|
|
||
| commits = list(repo.iter_commits('origin/master..HEAD')) |
There was a problem hiding this comment.
Does this work with PRs into stable branches?
There was a problem hiding this comment.
Most probably not. I will switch to the GH variable.
OhmSpectator
force-pushed
the
feature/commitlint
branch
2 times, most recently
from
8ffd216 to
127d7c7
Compare
|
Thanks for this PR @OhmSpectator , I think we were missing for a long time this feature, definitely it will help (enforce 😄 ) us to standardize and improve our commit messages.... I have just one comment, it could also check for a capitalized first word of the body message, as asked in our guidelines: https://github.com/lf-edge/eve/blob/master/CONTRIBUTING.md#commit-messages , but it can be done in a further iteration as well... |
Lol, I have never seen these guidelines =D |
OhmSpectator
force-pushed
the
feature/commitlint
branch
from
127d7c7 to
e954ccb
Compare
|
@rene, I've added the capital letter check. |
Introduced a GitHub Actions workflow (`commit-messages.yml`) to lint commit messages on `master`, version branches, and stable branches. Added `check_commit_messages.py` script to validate commit messages against recommended format (subject, empty line, body). Signed-off-by: Nikolay Martyanov <nikolay@zededa.com>
OhmSpectator
force-pushed
the
feature/commitlint
branch
from
e954ccb to
0eb892f
Compare
|
Thanks again @OhmSpectator , I'm approving this PR but I would like to drop one more idea here: it would be really nice to integrate this check as a git hook, you can provide a custom script to check commit message in |
|
Yeah, let's add a hool the next step. Let the team first get used to the rules by seeing failures in the GH Actions =) |
This PR introduces a new GitHub Actions workflow to automatically lint commit messages, ensuring they adhere to the recommended format. The workflow is triggered on pushes and pull requests to specific branches, including master and version branches. It includes a Python script that checks for the correct commit message format, ensuring that each message has a subject, an empty line separating the subject from the body, and a non-empty body. Additionally, the PR adds a requirements.txt file for managing dependencies and updates the .gitignore file to exclude the virtual environment directory. This enhancement helps maintain consistent and readable commit messages across the repository.