为 GitLab 编写脚本以自动合并合并请求

Question

我正在尝试编写一个脚本来合并打开的并符合合并请求标准（通过设置实现）的合并请求。

所以我唯一想做的是，我想编写一个 CI yaml 文件，我将安排它每 30 分钟左右运行一次，以检查打开的合并请求，如果可以合并则合并它们。

困惑一：

我可以通过编写多个 curl 请求来实现这一点，但我不确定如何在执行后一个接一个地使用它们。

所以，要检查打开的合并请求，我需要一个组的项目 ID，以获得我有一个 curl 命令，它将为我提供项目 ID，我将它们保存在一个文件中 projectid.txt .

curl -s --location --request GET --header 'PRIVATE-TOKEN:<PRIVATE_TOKEN>' '$CI_API_V4_URL/groups/'$GROUPID'/projects'  | sed 's/,/\n/g' | grep -w "id" | awk -F ':' '{print $2}' | sed -s 's/{"id"//g' 

现在，一旦我有了所有的项目 ID， 我想将它们流入另一个 curl 命令，即：

curl -s --location --request GET '$CI_API_V4_URL/projects/3/merge_requests?state=opened' --header 'PRIVATE-TOKEN:<PRIVATE_TOKEN>' | sed 's/,/\n/g' | grep -w "iid" | awk -F ':' '{print $2}' 

但是如果您看到上面的 curl 请求，我将手动提供3 以获得所需的输出。

但我希望这个 curl 命令自动获取 projectid.txt 每一行中存在的每个 projectid 并将其执行到第二个 curl 命令。这样我想要一个文件，它将明智地显示打开的合并请求项目。

一旦我得到所有这些信息，我想合并开放的合并请求，这些请求有效并且准备好合并（GitLab 负责检查它们是否准备好合并）

所以，我现在唯一需要的是，在另一个 curl 命令中输入 projectid 和 merge request id，这是一个 PUT 请求。

curl --location --request PUT '$CI_API_V4_URL/projects/3/merge_requests/26/merge' \
--header 'PRIVATE-TOKEN: <PRIVATE_TOKEN>'

来源：https://docs.gitlab.com/ee/api/merge_requests.html#accept-mr

如果您看到上述合并请求，我需要提供项目明智的合并请求。我对如何实现自动化有点困惑。

另外，你能告诉我这是否是利用我的gitlab-ci.yml 文件中的这些许多 curl 请求来自动执行此操作的正确方法吗？还有其他方法可以通过Python 或shell 脚本来实现吗？

另外，有没有什么简单的方法可以在 REST API 文档的帮助下编写 python 脚本？我能够生成 curl 请求以使用 REST API，但不确定如何使用 Python 来实现。

欢迎任何帮助或建议。

到目前为止，我的 gitlab-ci.yml 文件看起来像这样，因为在此之后我无法思考太多：

variables:
  GROUPID: 6
stages:
  - cleanup

cleanup-code-job:
  stage: cleanup
  tags:
    - build
  script:
    - echo "$GROUPID"
    ##Below curl command can be used to identify projects in group
    - curl -s --location --request GET --header 'PRIVATE-TOKEN:<PRIVATE_TOKEN>' '$CI_API_V4_URL/groups/'$GROUPID'/projects'  | sed 's/,/\n/g' | grep -w "id" | awk -F ':' '{print $2}' | sed -s 's/{"id"//g' > projects.txt
    - cat projects.txt

谢谢

Answer 1

使用python-gitlab library，python 脚本使这个任务的脚本编写变得更加简单，尤其是在涉及到分页时。

此外，您可以使用Group merge requests API 作为快捷方式，而不是列出组中的所有项目，然后列出每个项目中的所有合并请求。

使用 Python 脚本，它可能看起来像这样：

import gitlab
from gitlab.v4.objects import GroupMergeRequest
TOKEN = "your API key"
GITLAB_HOST = 'https://gitlab.com' # or your instance
gl = gitlab.Gitlab(GITLAB_HOST, private_token=TOKEN)

GROUP_ID = 123

def mr_meets_merge_criteria(mr: GroupMergeRequest) -> bool:
    """
    A function to check if it meets criteria to
    be merged automatically by this script
    """
    print(mr.project_id)
    print(mr.merge_status)  # e.g. 'can_be_merged'
    # check something
    ...
    return True | False

group = gl.groups.get(GROUP_ID)

# loop over all merge requests in the group
for mr in group.mergerequests.list(as_list=False):
    if mr_meets_merge_criteria(mr):
        project = gl.projects.get(mr.project_id, lazy=True)
        project_mr = project.mergerequests.get(mr.iid)
        project_mr.merge()

所以，如果你输入了正确的常量并完成了mr_meets_merge_criteria函数的实现，那么这就是你所需要的:-)