如何解决命令行创建多行描述GitLab MR时的换行符报错问题

问题背景 #

我正在编写一个通过命令行创建GitLab合并请求（MR）的Python脚本，使用subprocess模块调用git push命令并传递push选项。当前代码尝试将多行文本作为MR描述，但运行时Git报错：

fatal: push options must not have new line characters

Git版本为2.39.5，需要保留MR的多行描述格式。

当前代码：

description = [
    "This is the first line of the description.",
    "The description has multiple lines.",
    "Each line is an element in this list."
]

git_MR_options = [
    '-o merge_request.create',
    # ... other options
    '-o merge_request.description="' + '\n'.join(description) + '"'
]

subprocess.run(
    ["git", "push", * git_MR_options],
    check=True, text=True, capture_output=True
)

解决方案 #

方法一：使用GitLab API创建MR（推荐） #

Git的push选项本身限制了参数不能包含换行符，改用GitLab API直接创建MR是最可靠的方式，完全支持多行描述，且功能更灵活。

示例代码：

import requests

# 替换为你的实际配置
GITLAB_INSTANCE = "https://gitlab.com"  # 或你的私有GitLab地址
PRIVATE_TOKEN = "your-personal-access-token"
PROJECT_ID = "123456"  # 项目ID，可在项目主页找到
SOURCE_BRANCH = "feature/new-feature"
TARGET_BRANCH = "main"
MR_TITLE = "Add new feature module"

description = [
    "This is the first line of the description.",
    "The description has multiple lines.",
    "Each line is an element in this list."
]
mr_description = "\n".join(description)

# 发送API请求创建MR
api_url = f"{GITLAB_INSTANCE}/api/v4/projects/{PROJECT_ID}/merge_requests"
headers = {"PRIVATE-TOKEN": PRIVATE_TOKEN}
payload = {
    "source_branch": SOURCE_BRANCH,
    "target_branch": TARGET_BRANCH,
    "title": MR_TITLE,
    "description": mr_description
}

response = requests.post(api_url, headers=headers, data=payload)
response.raise_for_status()  # 抛出请求异常
mr_info = response.json()
print(f"MR创建成功！地址：{mr_info['web_url']}")

方法二：用Markdown换行标记替代原生换行 #

GitLab的MR描述支持Markdown语法，可将换行符替换为<br>标签，这样在MR页面显示时会自动换行，同时规避Git push选项的换行限制。

修改后的代码：

description = [
    "This is the first line of the description.",
    "The description has multiple lines.",
    "Each line is an element in this list."
]

# 用<br>替换换行符，GitLab会解析为换行
formatted_desc = "<br>".join(description)

git_MR_options = [
    '-o', 'merge_request.create',
    # 其他选项
    '-o', f'merge_request.description={formatted_desc}'
]

subprocess.run(
    ["git", "push", *git_MR_options],
    check=True, text=True, capture_output=True
)

注意：将-o和对应的选项拆分为列表的独立元素，避免手动添加引号，subprocess会自动正确传递参数。

方法三：先推送分支，再用GitLab CLI创建MR #

如果已安装GitLab CLI（glab），可以先推送分支，再用命令创建MR，支持直接传递多行描述：

import subprocess

SOURCE_BRANCH = "feature/new-feature"
MR_TITLE = "Add new feature module"
description = [
    "This is the first line of the description.",
    "The description has multiple lines.",
    "Each line is an element in this list."
]
description_str = "\n".join(description)

# 先推送分支
subprocess.run(["git", "push", "origin", SOURCE_BRANCH], check=True)

# 用glab创建MR，支持多行描述
subprocess.run(
    ["glab", "mr", "create", "--title", MR_TITLE, "--description", description_str],
    check=True, text=True
)

内容的提问来源于stack exchange，提问作者py_coffee