mirror of
https://github.com/penpot/penpot.git
synced 2026-11-18 16:12:24 +00:00
The checker rejected any Co-authored-by trailer, which also blocked a real person. The trailer is meant to credit a human co-author, and git and GitHub use it for that; only AI providers, agents and bots are unwanted. Match the trailer value against a blocklist of providers and agents plus bot identities, and point to the dedicated AI-assisted-by trailer for AI participation. Co-authored-by joins the trailer exemption of the 80-character body rule. Update the tests, CONTRIBUTING.md, the create-commit skill and the commit memory to the new rule. AI-assisted-by: deepseek-v4.1-flash Signed-off-by: Andrey Antukh <niwi@niwi.nz>
306 lines
11 KiB
Python
Executable File
306 lines
11 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
"""
|
|
Check commit messages against Penpot's commit guidelines.
|
|
|
|
Validates commit messages using the rules defined in:
|
|
- .github/workflows/commit-checker.yml (regex pattern)
|
|
- CONTRIBUTING.md (formatting rules, subject length, DCO)
|
|
- .serena/memories/workflow/creating-commits.md (body wrapped at 80 chars)
|
|
|
|
By default, checks HEAD. Use --commit to specify a different commit.
|
|
|
|
Usage:
|
|
./scripts/check-commit
|
|
./scripts/check-commit --commit HEAD~1
|
|
./scripts/check-commit -c abc1234
|
|
"""
|
|
|
|
import argparse
|
|
import re
|
|
import subprocess
|
|
import sys
|
|
|
|
# ── Emoji list ───────────────────────────────────────────────────────────────
|
|
# Combined from commit-checker.yml AND CONTRIBUTING.md
|
|
VALID_EMOJIS = (
|
|
"lipstick|globe_with_meridians|wrench|books|"
|
|
"arrow_up|arrow_down|zap|ambulance|construction|"
|
|
"boom|fire|whale|bug|sparkles|paperclip|tada|"
|
|
"recycle|rewind|construction_worker|rocket"
|
|
)
|
|
|
|
# ── Regex from .github/workflows/commit-checker.yml ──────────────────────────
|
|
# Matches:
|
|
# 1) ":emoji: <Capitalized subject without trailing dot>"
|
|
# 2) "Merge|Revert|Reapply ... without trailing dot"
|
|
COMMIT_PATTERN = re.compile(
|
|
r"^((:(" + VALID_EMOJIS + r"):\s[A-Z].*[^.]))$"
|
|
)
|
|
|
|
MERGE_PATTERN = re.compile(r"^(Merge|Revert|Reapply).+[^.]$")
|
|
|
|
# ── Subject line length ──────────────────────────────────────────────────────
|
|
# Subject lines must fit in 80 characters. Merge/Revert/Reapply commits are
|
|
# exempt: git prepends "Merge ..."/"Revert ..." to an existing subject, so
|
|
# enforcing the limit would fail on text the author did not write.
|
|
MAX_SUBJECT_LINE = 80
|
|
|
|
# ── Body line wrapping ───────────────────────────────────────────────────────
|
|
# Commit bodies must wrap at 80 characters (see
|
|
# .serena/memories/workflow/creating-commits.md). Trailers and
|
|
# URLs are exempt: they cannot be wrapped without losing meaning.
|
|
MAX_BODY_LINE = 80
|
|
|
|
TRAILER_PATTERN = re.compile(
|
|
r"^(Signed-off-by|Co-authored-by|Co-developed-by|Reviewed-by|"
|
|
r"Acked-by|Tested-by|Reported-by|Suggested-by|AI-assisted-by):"
|
|
)
|
|
|
|
# ── Co-authored-by trailer ───────────────────────────────────────────────────
|
|
# A human co-author may be credited with Co-authored-by. The trailer is
|
|
# forbidden when its value names an AI provider, an AI agent, or a bot: for AI
|
|
# participation the message uses "AI-assisted-by: <model>" instead.
|
|
# Extend this list when a new tool starts adding trailers.
|
|
NON_HUMAN_COAUTHOR_PATTERN = re.compile(
|
|
r"^\s*co-authored-by\s*:.*("
|
|
r"\b(?:chatgpt|openai|anthropic|claude|copilot|codex|gemini|bard|"
|
|
r"deepseek|mistral|qwen|kimi|llama|grok|cursor|"
|
|
r"windsurf|cline|aider|codeium|tabnine|amazon\s+q|sourcegraph\s+cody|"
|
|
r"roo\s+code|kilo\s+code|opencode)\b"
|
|
r"|\bdevin-ai|@devin\.ai"
|
|
r"|\[bot\]|\bbot@"
|
|
r")",
|
|
re.IGNORECASE,
|
|
)
|
|
|
|
URL_PATTERN = re.compile(r"https?://\S+")
|
|
|
|
# ═══════════════════════════════════════════════════════════════════════════════
|
|
# Helpers
|
|
# ═══════════════════════════════════════════════════════════════════════════════
|
|
|
|
def run_git(args):
|
|
"""Run a git command and return (returncode, stdout, stderr)."""
|
|
try:
|
|
result = subprocess.run(
|
|
["git"] + args,
|
|
capture_output=True,
|
|
text=True,
|
|
check=False,
|
|
)
|
|
return result.returncode, result.stdout, result.stderr
|
|
except FileNotFoundError:
|
|
print("ERROR: git not found. Is it installed?", file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
|
|
def get_commit_message(commit_ref):
|
|
"""Return the full commit message for *commit_ref*."""
|
|
rc, out, err = run_git(["log", "--format=%B", "-n", "1", commit_ref])
|
|
if rc != 0:
|
|
print(f"ERROR: could not read commit {commit_ref}: {err.strip()}", file=sys.stderr)
|
|
sys.exit(1)
|
|
if not out.strip():
|
|
print(f"ERROR: commit {commit_ref} has no message", file=sys.stderr)
|
|
sys.exit(1)
|
|
return out.rstrip("\n")
|
|
|
|
|
|
# ═══════════════════════════════════════════════════════════════════════════════
|
|
# Validators
|
|
# ═══════════════════════════════════════════════════════════════════════════════
|
|
|
|
def check_regex(message):
|
|
"""Check the commit message against the CI regex pattern."""
|
|
# Normalise: strip trailing newlines for single-line matching
|
|
first_line = message.split("\n")[0]
|
|
|
|
if MERGE_PATTERN.match(first_line):
|
|
return True, None
|
|
|
|
if COMMIT_PATTERN.match(first_line):
|
|
return True, None
|
|
|
|
return False, (
|
|
"Commit subject must match one of:\n"
|
|
" :emoji: <Capitalized subject without trailing dot>\n"
|
|
" Merge|Revert|Reapply <rest without trailing dot>\n"
|
|
f"Got: {first_line!r}"
|
|
)
|
|
|
|
|
|
def check_subject_length(message):
|
|
"""Subject line must be ≤ 80 characters (Merge/Revert/Reapply exempt)."""
|
|
first_line = message.split("\n")[0]
|
|
if MERGE_PATTERN.match(first_line):
|
|
return True, None
|
|
if len(first_line) > MAX_SUBJECT_LINE:
|
|
return False, (
|
|
f"Subject line exceeds {MAX_SUBJECT_LINE} characters ({len(first_line)} chars):\n"
|
|
f" {first_line}"
|
|
)
|
|
return True, None
|
|
|
|
|
|
def check_subject_no_trailing_dot(message):
|
|
"""Subject line must not end with a period ('.')."""
|
|
first_line = message.split("\n")[0]
|
|
if first_line.endswith("."):
|
|
return False, (
|
|
"Subject line must not end with a period:\n"
|
|
f" {first_line}"
|
|
)
|
|
return True, None
|
|
|
|
|
|
def check_subject_capitalized(message):
|
|
"""Subject must be capitalized, but only if it's a regular commit (not Merge/Revert/Reapply)."""
|
|
first_line = message.split("\n")[0]
|
|
|
|
# Skip check for Merge/Revert/Reapply commits
|
|
if MERGE_PATTERN.match(first_line):
|
|
return True, None
|
|
|
|
# Strip emoji prefix before checking capitalization
|
|
emoji_match = re.match(r"^:([a-z_]+):\s+(.*)", first_line)
|
|
if emoji_match:
|
|
rest = emoji_match.group(2)
|
|
else:
|
|
rest = first_line
|
|
|
|
if rest and not rest[0].isupper():
|
|
return False, (
|
|
"Subject line must start with a capital letter "
|
|
"(after the emoji prefix):\n"
|
|
f" {first_line}"
|
|
)
|
|
return True, None
|
|
|
|
|
|
def check_body_blank_line(message):
|
|
"""If a body exists, there must be a blank line between subject and body."""
|
|
lines = message.split("\n")
|
|
if len(lines) >= 3 and lines[1] != "":
|
|
return False, (
|
|
"A blank line must separate the subject from the body."
|
|
)
|
|
return True, None
|
|
|
|
|
|
def check_body_line_length(message):
|
|
"""Body lines must wrap at 80 characters or fewer.
|
|
|
|
The subject (first line) has its own length rule. Trailers (e.g.
|
|
Signed-off-by) and lines carrying a URL are exempt, since wrapping them
|
|
would break tooling or lose information.
|
|
"""
|
|
lines = message.split("\n")
|
|
offenders = []
|
|
|
|
for line_number, line in enumerate(lines[1:], start=2):
|
|
if len(line) <= MAX_BODY_LINE:
|
|
continue
|
|
if TRAILER_PATTERN.match(line):
|
|
continue
|
|
if URL_PATTERN.search(line):
|
|
continue
|
|
# A long token with no whitespace before the limit cannot be wrapped.
|
|
if " " not in line[:MAX_BODY_LINE]:
|
|
continue
|
|
offenders.append((line_number, line))
|
|
|
|
if not offenders:
|
|
return True, None
|
|
|
|
details = "\n".join(
|
|
f" line {line_number} ({len(line)} chars): {line!r}"
|
|
for line_number, line in offenders
|
|
)
|
|
return False, (
|
|
f"Body lines must wrap at {MAX_BODY_LINE} characters or fewer. "
|
|
"Unwrapped line(s):\n" + details
|
|
)
|
|
|
|
|
|
def check_signed_off_by(message):
|
|
"""Check for the DCO Signed-off-by line (required for code changes)."""
|
|
if "Signed-off-by:" not in message:
|
|
return False, (
|
|
"Missing 'Signed-off-by:' line in the commit footer.\n"
|
|
" Add it with 'git commit -s' or append it manually:\n"
|
|
" Signed-off-by: Your Real Name <your.email@example.com>"
|
|
)
|
|
return True, None
|
|
|
|
|
|
def check_co_authored_by(message):
|
|
"""Co-authored-by is allowed for humans, not for AI providers or bots."""
|
|
offenders = [
|
|
(line_number, line)
|
|
for line_number, line in enumerate(message.split("\n"), start=1)
|
|
if NON_HUMAN_COAUTHOR_PATTERN.match(line)
|
|
]
|
|
if not offenders:
|
|
return True, None
|
|
details = "\n".join(
|
|
f" line {line_number}: {line!r}"
|
|
for line_number, line in offenders
|
|
)
|
|
return False, (
|
|
"The 'Co-authored-by:' trailer is only for human co-authors. This one "
|
|
"names an AI provider, an AI agent, or a bot. Offending line(s):\n"
|
|
+ details
|
|
+ "\n For AI participation use: AI-assisted-by: <model-name>"
|
|
)
|
|
|
|
|
|
# ═══════════════════════════════════════════════════════════════════════════════
|
|
|
|
def main():
|
|
parser = argparse.ArgumentParser(
|
|
description="Check a commit message against Penpot commit guidelines."
|
|
)
|
|
parser.add_argument(
|
|
"-c", "--commit",
|
|
default="HEAD",
|
|
help="Commit to check (default: HEAD)",
|
|
)
|
|
args = parser.parse_args()
|
|
|
|
commit_ref = args.commit
|
|
message = get_commit_message(commit_ref)
|
|
|
|
print(f"Checking commit {commit_ref} ...\n")
|
|
|
|
validators = [
|
|
("Regex pattern", check_regex),
|
|
("Subject ≤ 80 chars", check_subject_length),
|
|
("No trailing period in subject", check_subject_no_trailing_dot),
|
|
("Subject capitalized", check_subject_capitalized),
|
|
("Blank line after subject", check_body_blank_line),
|
|
("Body wrapped at 80 chars", check_body_line_length),
|
|
("Co-authored-by is human only", check_co_authored_by),
|
|
]
|
|
|
|
all_ok = True
|
|
|
|
for name, validator in validators:
|
|
ok, error_msg = validator(message)
|
|
status = "✓" if ok else "✗"
|
|
print(f" [{status}] {name}")
|
|
if not ok:
|
|
all_ok = False
|
|
print(f" {error_msg}", file=sys.stderr)
|
|
|
|
print()
|
|
if all_ok:
|
|
print("All checks passed.")
|
|
sys.exit(0)
|
|
else:
|
|
print("Some checks FAILED. See messages above.", file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|