validate_commit_message.py

# /// script
# requires-python = ">=3.11"
# dependencies = [
#     "pygithub>=2.8.1,<3.0.0",
# ]
# ///

import os
import re
import subprocess
import sys
from pathlib import Path

import tomllib
from github import Github

with open("pyproject.toml", "rb") as fp:
    PYPROJECT_TOML = tomllib.load(fp)
KEYWORDS = ["fixes", "closes"]
BLOCKING_REGEX = [
    "DRAFT",
    "WIP",
    "NOMERGE",
    r"DO\s*NOT\s*MERGE",
    "EXPERIMENT",
]
CHANGELOG_EXTS = [f".{item['directory']}" for item in PYPROJECT_TOML["tool"]["towncrier"]["type"]]
NOISSUE_MARKER = "[noissue]"

sha = sys.argv[1]
message = subprocess.check_output(["git", "log", "--format=%B", "-n 1", sha]).decode("utf-8")

if NOISSUE_MARKER in message:
    sys.exit("Do not add '[noissue]' in the commit message.")

if any(re.match(pattern, message) for pattern in BLOCKING_REGEX):
    sys.exit("This PR is not ready for consumption.")

g = Github(os.environ.get("GITHUB_TOKEN"))
repo = g.get_repo("pulp/pulp-cli-maven")


def check_status(issue: str) -> None:
    gi = repo.get_issue(int(issue))
    if gi.pull_request:
        sys.exit(f"Error: issue #{issue} is a pull request.")
    if gi.closed_at:
        sys.exit(f"Error: issue #{issue} is closed.")


def check_changelog(issue: str) -> None:
    matches = list(Path("CHANGES").rglob(f"{issue}.*"))

    if len(matches) < 1:
        sys.exit(f"Could not find changelog entry in CHANGES/ for {issue}.")
    for match in matches:
        if match.suffix not in CHANGELOG_EXTS:
            sys.exit(f"Invalid extension for changelog entry '{match}'.")


print(f"Checking commit message for {sha[0:7]}.")

# validate the issue attached to the commit
issue_regex = r"(?:{keywords})[\s:]+#(\d+)".format(keywords=("|").join(KEYWORDS))
issues = re.findall(issue_regex, message, re.IGNORECASE)
cherry_pick_regex = r"^\s*\(cherry picked from commit [0-9a-f]*\)\s*$"
cherry_pick = re.search(cherry_pick_regex, message, re.MULTILINE)

if issues:
    for issue in issues:
        if not cherry_pick:
            check_status(issue)
            check_changelog(issue)

print(f"Commit message for {sha[0:7]} passed.")