如何使用 Python 创建新分支、推送文本文件并向 gitlab 存储库发送合并请求？

Question

我发现 https://github.com/python-gitlab/python-gitlab，但我无法理解文档中的示例。

Answer 1

没错，我们在文档中找不到任何测试。这是您问题的基本答案。

如果您想要完整的工作脚本，我已将其附在此处： https://github.com/hubshashwat/common_scripts/blob/main/automation_to_create_push_merge_in_gitlab/usecase_gitlab_python.py

分解以下步骤：

为您创建一个身份验证密钥：按照此处的步骤操作：https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html

创建项目的 gitlab 服务器实例

server = gitlab.Gitlab('https://gitlab.example.com', private_token=YOUR_API_TOKEN)
project = server.projects.get(PROJECT_ID)

使用以下命令创建分支：

branch = project.branches.create(
    {"branch": branch_name, "ref": project.default_branch}
)

使用以下方式上传文件：

project.files.create(
    {
        "file_path": file_name,
        "branch": branch.name,
        "content": "data to be written",
        "encoding": "text",  # or 'base64'; useful for binary files
        "author_email": AUTHOR_EMAIL, # Optional
        "author_name": AUTHOR_NAME,  # Optional
        "commit_message": "Create file",
    }
)

使用以下方法创建合并请求：

project.mergerequests.create(
    {
        "source_branch": branch.name,
        "target_branch": project.default_branch,
        "title": "merge request title",
    }
)

Answer 2

看着

python-gitlab

，我没有看到你正在寻找的一些东西。在这种情况下，我建议您将其分解并使用更基本的工具和库执行各个步骤。

前两部分你不需要使用Gitlab API来完成。您基本上可以使用 Python 使用

git.exe

并针对磁盘进行克隆、分支、编辑和提交调用。在某些方面，这更容易，因为您可以自己复制呼叫。您可以使用GitPython。

我建议您通过其中一种方法来完成此操作，而不是尝试通过 Gitlab API 来完成此操作。如果您在本地（甚至在 CI 内）进行分支工作，则更容易理解、调试和调查。

将代码推送到分支后，您可以使用 Gitlab 的 API 通过 REST（例如

requests

库）创建合并请求。创建 MR 的说明位于 https://docs.gitlab.com/ee/api/merge_requests.html#create-mr，大多数字段都是可选的，因此最小值如下所示：

{
  "id": "some-user%2Fsome-project",
  "source_branch": "name_of_your_mr_branch",
  "target_branch": "main",
  "title": "Automated Merge Request..."
}

这是一个经过身份验证的 POST 调用（用于创建）。在这些链接之间，您应该拥有执行此操作所需的大部分内容。