mirror of
https://github.com/cloud-hypervisor/cloud-hypervisor.git
synced 2024-12-22 05:35:20 +00:00
build: add gitlint commit message linter
Implement commit message check workflow using gitlint Fixes: #5840 Signed-off-by: Ruslan Mstoi <ruslan.mstoi@intel.com>
This commit is contained in:
parent
5f3ff3c44a
commit
ea7999e064
26
.github/workflows/gitlint.yaml
vendored
Normal file
26
.github/workflows/gitlint.yaml
vendored
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
name: Commit messages check
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
gitlint:
|
||||||
|
name: Check commit messages
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
ref: ${{ github.event.pull_request.head.sha }}
|
||||||
|
fetch-depth: 0
|
||||||
|
- name: Set up Python 3.10
|
||||||
|
uses: actions/setup-python@v3
|
||||||
|
with:
|
||||||
|
python-version: "3.10"
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
python -m pip install --upgrade pip
|
||||||
|
pip install --upgrade gitlint
|
||||||
|
- name: Lint git commit messages
|
||||||
|
run: |
|
||||||
|
gitlint --commits origin/$GITHUB_BASE_REF..
|
15
.gitlint
Normal file
15
.gitlint
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
[general]
|
||||||
|
extra-path=scripts/gitlint/rules.py
|
||||||
|
regex-style-search=true
|
||||||
|
|
||||||
|
[ignore-by-author-name]
|
||||||
|
regex=dependabot
|
||||||
|
ignore=all
|
||||||
|
|
||||||
|
# default 72
|
||||||
|
[title-max-length]
|
||||||
|
line-length=50
|
||||||
|
|
||||||
|
# default 80
|
||||||
|
[body-max-line-length]
|
||||||
|
line-length=72
|
75
scripts/gitlint/rules.py
Normal file
75
scripts/gitlint/rules.py
Normal file
@ -0,0 +1,75 @@
|
|||||||
|
from gitlint.rules import LineRule, RuleViolation, CommitMessageTitle
|
||||||
|
import re
|
||||||
|
|
||||||
|
|
||||||
|
class TitleStartsWithComponent(LineRule):
|
||||||
|
"""This rule will enforce that the commit message title starts with valid
|
||||||
|
component name
|
||||||
|
"""
|
||||||
|
|
||||||
|
# A rule MUST have a human friendly name
|
||||||
|
name = "title-has-valid-component"
|
||||||
|
|
||||||
|
# A rule MUST have a *unique* id.
|
||||||
|
# We recommend starting with UL (for User-defined Line-rule)
|
||||||
|
id = "UL1"
|
||||||
|
|
||||||
|
# A line-rule MUST have a target (not required for CommitRules).
|
||||||
|
target = CommitMessageTitle
|
||||||
|
|
||||||
|
def validate(self, line, _commit):
|
||||||
|
valid_components = [
|
||||||
|
'api_client',
|
||||||
|
'arch',
|
||||||
|
'block',
|
||||||
|
'build',
|
||||||
|
'ch-remote',
|
||||||
|
'ci',
|
||||||
|
'devices',
|
||||||
|
'docs',
|
||||||
|
'event_monitor',
|
||||||
|
'fuzz',
|
||||||
|
'github',
|
||||||
|
'gitignore',
|
||||||
|
'hypervisor',
|
||||||
|
'Jenkinsfile',
|
||||||
|
'misc',
|
||||||
|
'net_gen',
|
||||||
|
'net_util',
|
||||||
|
'option_parser',
|
||||||
|
'pci',
|
||||||
|
'performance-metrics',
|
||||||
|
'rate_limiter',
|
||||||
|
'README',
|
||||||
|
'resources',
|
||||||
|
'scripts',
|
||||||
|
'serial_buffer',
|
||||||
|
'test_data',
|
||||||
|
'test_infra',
|
||||||
|
'tests',
|
||||||
|
'tpm',
|
||||||
|
'tracer',
|
||||||
|
'vhost_user_block',
|
||||||
|
'vhost_user_net',
|
||||||
|
'virtio-devices',
|
||||||
|
'vm-allocator',
|
||||||
|
'vm-device',
|
||||||
|
'vmm',
|
||||||
|
'vm-migration',
|
||||||
|
'vm-virtio']
|
||||||
|
|
||||||
|
pattern = re.compile(r'^(.+):\s(.+)$')
|
||||||
|
match = pattern.match(line)
|
||||||
|
|
||||||
|
if not match:
|
||||||
|
self.log.debug("Invalid commit title {}", line)
|
||||||
|
return [RuleViolation(self.id, "Commit title does not comply with "
|
||||||
|
"rule: 'component: change summary'")]
|
||||||
|
component = match.group(1)
|
||||||
|
summary = match.group(2)
|
||||||
|
self.log.debug(f"\nComponent: {component}\nSummary: {summary}")
|
||||||
|
|
||||||
|
if component not in valid_components:
|
||||||
|
return [RuleViolation(self.id,
|
||||||
|
f"Invalid component: {component}, "
|
||||||
|
f"valid components are: {valid_components}")]
|
Loading…
Reference in New Issue
Block a user