From 8482c3590e8eb7dd4c962635ff04e6f244e319aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20K=C4=99pie=C5=84?= Date: Mon, 3 Jun 2024 13:07:21 +0200 Subject: [PATCH] Warn about auto-generated merge request titles Merge request titles auto-generated by GitLab are often a source of confusion regarding the actual contents of a given merge request. Warn for merge requests containing titles that look like auto-generated ones. (cherry picked from commit 80ec57f198e5706e653ebe2016f41dc6f856db8c) --- dangerfile.py | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/dangerfile.py b/dangerfile.py index 81eca5f583..d267572fa5 100644 --- a/dangerfile.py +++ b/dangerfile.py @@ -48,6 +48,7 @@ modified_files = danger.git.modified_files affected_files = ( danger.git.modified_files + danger.git.created_files + danger.git.deleted_files ) +mr_title = danger.gitlab.mr.title mr_labels = danger.gitlab.mr.labels source_branch = danger.gitlab.mr.source_branch target_branch = danger.gitlab.mr.target_branch @@ -61,6 +62,19 @@ gl = gitlab.Gitlab( proj = gl.projects.get(os.environ["CI_PROJECT_ID"]) mr = proj.mergerequests.get(os.environ["CI_MERGE_REQUEST_IID"]) +############################################################################### +# MERGE REQUEST INFORMATION +############################################################################### +# +# - WARN if the merge request's title looks like an auto-generated one. + +if mr_title.replace("Draft: ", "").startswith('Resolve "'): + warn( + f"This merge request's title (`{mr_title}`) looks like an " + "auto-generated one. Please change it so that it accurately " + "describes the changes contained in this merge request." + ) + ############################################################################### # BRANCH NAME ############################################################################### @@ -218,7 +232,7 @@ if is_backport: minor_ver, edition = VERSION_LABEL_RE.search(version_labels[0]).groups() edition = "" if edition is None else edition title_re = f"^\\[9.{minor_ver}{edition}\\]" - match = re.search(title_re, danger.gitlab.mr.title) + match = re.search(title_re, mr_title) if match is None: fail( "Backport MRs must have their target version in the title. "