fix(gitlab): remove custom author when commit signing is enabled

Author: Lujeni

gitlab2sentry/resources.py

@@ -1,11 +1,8 @@
-import os
 from collections import namedtuple
 from typing import List, Tuple
 from pydantic import Field
 from pydantic_settings import BaseSettings
 
-ENV = os.getenv("ENV", "production")
-
 
 class Settings(BaseSettings):
     env: str = Field("production")
@@ -26,7 +23,9 @@ class Settings(BaseSettings):
     project = {project_slug}
     """)
     dsn_branch_name: str = Field("auto_add_sentry_dsn")
-    dsn_mr_title: str = Field("[gitlab2sentry] Merge me to add your Sentry DSN to {project_name}")
+    dsn_mr_title: str = Field(
+        "[gitlab2sentry] Merge me to add your Sentry DSN to {project_name}"
+    )
     dsn_mr_description: str = Field("""
     {mentions} Congrats, your Sentry project has been
     created, merge this
@@ -41,7 +40,9 @@ class Settings(BaseSettings):
     url = {sentry_url}
     """)
     sentryclirc_branch_name: str = Field("auto_add_sentry")
-    sentryclirc_mr_title: str = Field("[gitlab2sentry] Merge me to add Sentry to {project_name} or close me")
+    sentryclirc_mr_title: str = Field(
+        "[gitlab2sentry] Merge me to add Sentry to {project_name} or close me"
+    )
     sentryclirc_filepath: str = Field(".sentryclirc")
     sentryclirc_com_msg: str = Field("Update .sentryclirc")
     sentryclirc_mr_description: str = Field("""
@@ -65,9 +66,10 @@ class Settings(BaseSettings):
     gitlab_rmv_src_branch: bool = Field(True)
     gitlab_token: str = Field("default-token")
     gitlab_url: str = Field("http://default-gitlab-url")
+    gitlab_signed_commit: bool = Field(False)
 
 
-settings = Settings() # type: ignore
+settings = Settings()  # type: ignore
 
 # G2SProject namedtuple configuration
 G2SProject = namedtuple(

gitlab2sentry/utils/gitlab_provider.py

@@ -181,16 +181,21 @@ def _get_or_create_sentryclirc(
                     full_path,
                 )
             )
-            f = project.files.create(
-                {
+            data = {
                     "author_email": settings.gitlab_author_email,
                     "author_name": settings.gitlab_author_name,
                     "branch": branch_name,
                     "commit_message": settings.sentryclirc_com_msg,
                     "content": content,
                     "file_path": file_path,
                 }
-            )
+            # Remove custom author details when signed commits are enabled.
+            # When commit signing is enabled in GitLab (e.g. via pre-hook), commit signing requires that the author information matches the identity of the signer.
+            # https://gitlab.com/gitlab-org/gitlab/-/merge_requests/150855
+            if settings.gitlab_signed_commit:
+                data.pop("author_email")
+                data.pop("author_name")
+            f = project.files.create(data=data)
 
     def _get_default_mentions(self, project: Project) -> str:
         return ", ".join(