[git] Add scafolding for commit message standardization #4129
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## contribution-guidelines #4129 +/- ##
========================================================
Coverage 89.31% 89.31%
========================================================
Files 259 259
Lines 15684 15684
========================================================
Hits 14008 14008
Misses 1676 1676 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Jean-sys77
approved these changes
Jun 12, 2025
ricab
force-pushed
the
commit-msg-std
branch
2 times, most recently
from
6ba0e31 to
62445ee
Compare
ricab
force-pushed
the
contribution-guidelines
branch
from
5598edb to
ea47b98
Compare
ricab
force-pushed
the
contribution-guidelines
branch
from
ea47b98 to
22a47f3
Compare
ricab
force-pushed
the
commit-msg-std
branch
2 times, most recently
from
25d7bb9 to
7231fa0
Compare
|
OK, I think this is ready (provided the base merges). Here is a workflow run with bad commits: https://github.com/canonical/multipass/actions/runs/16480729443/job/46594055132?pr=4272 @sharder996, would you recommend having this workflow in the branch protection, or as part of dynamic CI? |
Jean-sys77
approved these changes
Aug 16, 2025
Add a basic main function to the commit-msg verification script, verifying that it is invoked with the expected argument.
Read commit message, reporting any errors.
Give up checking whether rule 9 holds because there is no way to know with certainty whether a sentence-ending line also ends the paragraph, without relying on a blank line to separate it from the following one. As, for example, in the previous line and this one :) We could detect cases where the first word(s) of the following line could still fit in the line that ended the sentence, but that could also be just a case of poor wrapping. For example: This is a sentence. And this is another one. There is no way to decide if the above is a case of a paragraph without a blank line or just sub-optimal wrapping. I am opting not to enforce optimal wrapping at this point, since it is not explicitly required by the current rules. And poems should be allowed :)
Fix commit verification not failing due to sub-shell not updating outer variable that was used to indicate failure. Use a file instead.
levkropp
approved these changes
Aug 19, 2025
xmkg
reviewed
Aug 21, 2025
| - Consider setting your commit template to the .gitmessage file in the repository root: | ||
| * `git config --local commit.template .gitmessage` | ||
| - Consider adding the commit-msg file in the repository root as a git hook (in .git/hooks) | ||
| * `ln -s ../../git-hooks/commit-msg.py .git/hooks/commit-msg` |
There was a problem hiding this comment.
This would probably fail if one switches back to an older branch. I've tested with main, git didn't complain, so it shouldn't be an issue.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a commit message template, a python script to serve as a validation hook, and a workflow to verify PR commits with that script.
MULTI-2014, MULTI-2015, MULTI-2016, MULTI-2017, MULTI-2018