action #95581
closed
coordination #39719: [saga][epic] Detection of "known failures" for stable tests, easy test results review and easy tracking of known issues
coordination #19720: [epic] Simplify investigation of job failures
ci: Use a git commit message style checker size:S
Added by tinita over 3 years ago.
Updated about 3 years ago.
Category:
Feature requests
Description
We don't check commit messages, and even when looking at them in a Github PR, we might miss things.
For example when leaving out the blank line after the subject line, that's not visible in the Github UI.
But it is problematic when viewing the git log in a one-line mode (e.g. with --oneline, or with a tool like tig). Then the whole message is shown, not just the subject.
We could also check that the message starts with an uppercase letter, and optionally with something like t:, ci: etc.
Possible candidates:
The last one seems better.
My first try showed that it might not support everything that perl regexes support, e.g. \A did not work.
An alternative would be to implement it ourselves in a perl script, to be CI agnostic and to be able to call the check locally as well.
Acceptance Criteria¶
- AC 1: Run in OpenQA
- AC 2: A plan exists for the other repos
Related issues
2 (2 open — 0 closed)
- Status changed from New to Workable
- Target version changed from future to Ready
- Status changed from Workable to New
- Parent task set to #19720
This could be a good example of something that can be extended to other repos afterwards as well, e.g. os-autoinst-distri-opensuse, and such. As openQA can read the git log, e.g. for the "investigation" feature, having proper git commit messages makes sense and should be ensured.
- Subject changed from ci: Use a git commit message style checker to ci: Use a git commit message style checker size:S
- Description updated (diff)
- Status changed from New to Workable
- Assignee set to VANASTASIADIS
Open pr at https://github.com/os-autoinst/openQA/pull/4108.
Checks:
- commit subject must begin either with a capital letter (A-Z) or with a tag ([A-Za-z0-9]:).
- commit subject must be no longer than 72 characters
- commit subject and commit body must be separated by at least one blank line
- each line in commit body must be no longer than 80 characters
- Status changed from Workable to Resolved
The PR was already merged.
- Status changed from Resolved to Workable
Oh wait, AC 2 is still missing.
- Related to action #97454: Decide and implement predefined tags for the commit message checker added
- Status changed from Workable to In Progress
It remains to follow @okurz's advice in the last comment and this is ready to be resolved.
VANASTASIADIS wrote:
It remains to follow @okurz's advice in the last comment and this is ready to be resolved.
Can you please clarify what that means? Private chat doesn't count, we need it stated here and get the ticket resolved ;-)
As mentioned in chat, I ran into a case where the check failed because of commits that didn't originate in my branch i.e. - failed: "Merge pull request #4153 from cfconrad/allow_limit_parameter_for_job_overview. @tinita suggested we can only check one, or all commits via the action. I wonder, can't the upstream action be fixed if this is a limitation of the action?
I think next time this happens we should try to find out why the action included those commits.
- Due date set to 2021-09-24
- Status changed from In Progress to Feedback
Leaving this ticket open to investigate possible errors in checking older commit messages. Setting the due-date accordingly.
I'm not sure I clearly understand AC2. Enabling this in other repos is as simple as copying the workflow file to the .github/workflows dir of that repo. The file now exists in common (but since it's a subrepo, it will have to be manually copied to each project's workflow dir).
Should I bump the due date a few days and try to figure out a more straightforward way, or resolve it?
- Copied to action #99066: ci: Use a git commit message style checker in more repos added
- Status changed from Feedback to Resolved
I created #99066 which effectively is what we need to cover AC2 so no need to continue further here, resolving. Thanks!
- Due date deleted (
2021-09-24)
Also available in: Atom
PDF