xuemingqiang/mongo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

SERVER-119785: allow GUARD commits (#48170)

Browse Source 
GitOrigin-RevId: d380de4590824fc46bc8f02b0f572a21d7758e80
This commit is contained in:
Trevor Guidry
2026-02-18 12:12:18 -06:00
committed by MongoDB Bot
parent 78887ef497
commit 436caa65b0
3 changed files with 128 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
buildscripts/validate_commit_message.py
View File

@@ -32,12 +32,15 @@ import pathlib
import re
import subprocess
import pathspec
import requests
import structlog
import typer
from git import Commit, Repo
from typing_extensions import Annotated
from buildscripts.bazel_rules_mongo.utils.evergreen_git import get_changed_files
LOGGER = structlog.get_logger(__name__)
STATUS_OK = 0
@@ -55,16 +58,24 @@ with open(repo_root / ".github" / "pull_request_template.md", "r") as r:
BANNED_STRINGS = ["https://spruce.mongodb.com", "https://evergreen.mongodb.com", pr_template]
VALID_SUMMARY = re.compile(r'(Revert ")?(SERVER-[0-9]+|Import wiredtiger)')
VALID_SUMMARY = re.compile(r'(?:Revert ")?(?:([A-Z]+)-[0-9]+|Import wiredtiger)')
# The allowed jira projects and their corresponding allowed file paths.
# allowed file paths are in gitignore format
ALLOWED_JIRA_PROJECTS = {
"SERVER": ["**/*"], # SERVER commits can modify any file
"GUARD": ["monguard/**/*"], # GUARD commits can only modify files in the monguard directory
}
def is_valid_commit(commit: Commit) -> bool:
def is_valid_commit(commit: Commit, changed_files: list[str] = []) -> bool:
# Valid values look like:
# 1. SERVER-\d+
# 2. Revert "SERVER-\d+
# 3. Import wiredtiger
# 4. Revert "Import wiredtiger
if not VALID_SUMMARY.match(commit.summary):
match = VALID_SUMMARY.match(commit.summary)
if not match:
LOGGER.error(
f"""PR summary is not valid; it must match the regular expression: {VALID_SUMMARY}
Current summary: {commit.summary}
@@ -74,6 +85,26 @@ The decision to add this check was made in SERVER-101443, please feel free to le
)
return False
# get the jira project from the regex, this will be none for wiredtiger imports
jira_project = match.group(1)
if jira_project:
# if there is a jira project, check that it is in the allowed list
if jira_project not in ALLOWED_JIRA_PROJECTS:
LOGGER.error(
f"PR summary contains an invalid Jira project {jira_project}; it must be one of: {list(ALLOWED_JIRA_PROJECTS.keys())}"
)
return False
allowed_file_paths = ALLOWED_JIRA_PROJECTS[jira_project]
spec = pathspec.PathSpec.from_lines("gitwildmatch", allowed_file_paths)
for file in changed_files:
if not spec.match_file(file):
LOGGER.error(
f"""PR summary indicates Jira project {jira_project} but the PR modifies file {file} which is not allowed for that Jira project."""
)
return False
# Remove all whitespace from comparisons. GitHub line-wraps commit messages, which adds
# newline characters that otherwise would not match verbatim such banned strings.
stripped_message = "".join(commit.message.split())
@@ -205,8 +236,9 @@ def main(
LOGGER.error("Running with an invalid requester", requester=requester)
raise typer.Exit(code=STATUS_ERROR)
changed_files = get_changed_files("../expansions.yml", diff_filter=None)
for commit in commits:
if not is_valid_commit(commit):
if not is_valid_commit(commit, changed_files):
LOGGER.error("Invalid commit, unable to merge")
raise typer.Exit(code=STATUS_ERROR)