oss/miniflux-v2
oss/miniflux-v2
1
0
Fork 0
mirror of https://github.com/miniflux/v2.git synced 2025-08-06 17:41:00 +00:00
Code Wiki Activity

ci: update commit linter to allow default Git revert message

Browse source
This commit is contained in:
Frédéric Guillot 2025-07-23 20:03:04 -07:00
parent a62b97bddd
commit bf466425db
1 changed files with 10 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

30
.github/workflows/scripts/commit-checker.py vendored
View file

@ -4,8 +4,10 @@ import sys
import argparse import argparse
from typing import Match from typing import Match
# Conventional commit pattern # Conventional commit pattern (including Git revert messages)
CONVENTIONAL_COMMIT_PATTERN: str = r"^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\([a-z0-9-]+\))?!?: .{1,100}" CONVENTIONAL_COMMIT_PATTERN: str = (
r"^((build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\([a-z0-9-]+\))?!?: .{1,100}|Revert .+)"
)
def get_commit_message(commit_hash: str) -> str: def get_commit_message(commit_hash: str) -> str:
@ -23,9 +25,7 @@ def get_commit_message(commit_hash: str) -> str:
sys.exit(1) sys.exit(1)
def check_commit_message( def check_commit_message(message: str, pattern: str = CONVENTIONAL_COMMIT_PATTERN) -> bool:
message: str, pattern: str = CONVENTIONAL_COMMIT_PATTERN
) -> bool:
"""Check if commit message follows conventional commit format.""" """Check if commit message follows conventional commit format."""
first_line: str = message.split("\n")[0] first_line: str = message.split("\n")[0]
match: Match[str] | None = re.match(pattern, first_line) match: Match[str] | None = re.match(pattern, first_line)
@ -50,9 +50,7 @@ def check_commit_range(base_ref: str, head_ref: str) -> list[dict[str, str]]:
for commit_hash in commit_hashes: for commit_hash in commit_hashes:
message: str = get_commit_message(commit_hash) message: str = get_commit_message(commit_hash)
if not check_commit_message(message): if not check_commit_message(message):
non_compliant.append( non_compliant.append({"hash": commit_hash, "message": message.split("\n")[0]})
{"hash": commit_hash, "message": message.split("\n")[0]}
)
return non_compliant return non_compliant
except subprocess.CalledProcessError as e: except subprocess.CalledProcessError as e:
@ -61,15 +59,9 @@ def check_commit_range(base_ref: str, head_ref: str) -> list[dict[str, str]]:
def main() -> None: def main() -> None:
parser: argparse.ArgumentParser = argparse.ArgumentParser( parser: argparse.ArgumentParser = argparse.ArgumentParser(description="Check conventional commit compliance")
description="Check conventional commit compliance" parser.add_argument("--base", required=True, help="Base ref (starting commit, exclusive)")
) parser.add_argument("--head", required=True, help="Head ref (ending commit, inclusive)")
parser.add_argument(
"--base", required=True, help="Base ref (starting commit, exclusive)"
)
parser.add_argument(
"--head", required=True, help="Head ref (ending commit, inclusive)"
)
args: argparse.Namespace = parser.parse_args() args: argparse.Namespace = parser.parse_args()
non_compliant: list[dict[str, str]] = check_commit_range(args.base, args.head) non_compliant: list[dict[str, str]] = check_commit_range(args.base, args.head)
@ -80,9 +72,7 @@ def main() -> None:
print(f"- {commit['hash'][:8]}: {commit['message']}") print(f"- {commit['hash'][:8]}: {commit['message']}")
print("\nPlease ensure your commit messages follow the format:") print("\nPlease ensure your commit messages follow the format:")
print("type(scope): subject") print("type(scope): subject")
print( print("\nWhere type is one of: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test")
"\nWhere type is one of: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test"
)
sys.exit(1) sys.exit(1)
else: else:
print("All commits follow the conventional commit format!") print("All commits follow the conventional commit format!")