如何在 Gitlab 中成功的管道末尾创建合并请求?

问题描述 投票:0回答:3

我对 gitlab 和 gitlab CI 非常陌生,我已经建立了一个正在成功完成的管道。 我的主分支和开发分支受到保护,因此需要合并请求,以便组中的另一个开发人员可以在合并之前查看代码和评论。 我想知道是否可以在此管道的末尾生成此合并请求。 gitlab 存储库中是否有此设置,或者我是否必须创建一个脚本来实现此目的?
旁注:
就在发布这篇文章之前,我遇到了 gitlab 文档的这一部分
我在 ubuntu 18.04 上使用 gitlab-runner 11.0.0

git gitlab gitlab-ci-runner
3个回答
12
投票

为了实现我的简单需求,我只是在管道中添加了最后一个阶段,该阶段本质上执行改编自这篇文章的 bash 脚本。

编辑: 根据@Yuva 的要求

# Create a pull request on pipeline success
create_merge_request:
  stage: createMR
  tags:
    - autoMR
  script:
    - 'echo Merge request opened by $GITLAB_USER_NAME '
    - ~/commit.sh

并在commit.sh中

#!/bin/bash
# This script was adapted from:
# https://about.gitlab.com/2017/09/05/how-to-automatically-create-a-new-mr-on-gitlab-with-gitlab-ci/

# TODO determine URL from git repository URL
[[ $HOST =~ ^https?://[^/]+ ]] && HOST="${BASH_REMATCH[0]}/api/v4/projects/"

# The branch which we wish to merge into
TARGET_BRANCH=develop;

# The user's token name so that we can open the merge request as the user
TOKEN_NAME=`echo ${GITLAB_USER_LOGIN}_COMMIT_TOKEN | tr "[a-z]" "[A-Z]"`

# See: http://www.tldp.org/LDP/abs/html/parameter-substitution.html search ${!varprefix*}, ${!varprefix@} section
PRIVATE_TOKEN=`echo ${!TOKEN_NAME}`

# The description of our new MR, we want to remove the branch after the MR has
# been closed
BODY="{
\"project_id\": ${CI_PROJECT_ID},
\"source_branch\": \"${CI_COMMIT_REF_NAME}\",
\"target_branch\": \"${TARGET_BRANCH}\",
\"remove_source_branch\": false,
\"force_remove_source_branch\": false,
\"allow_collaboration\": true,
\"subscribed\" : true,
\"title\": \"${GITLAB_USER_NAME} merge request for: ${CI_COMMIT_REF_SLUG}\"
}";

# Require a list of all the merge request and take a look if there is already
# one with the same source branch
 LISTMR=`curl --silent "${HOST}${CI_PROJECT_ID}/merge_requests?state=opened" --header "PRIVATE-TOKEN:${PRIVATE_TOKEN}"`;
 COUNTBRANCHES=`echo ${LISTMR} | grep -o "\"source_branch\":\"${CI_COMMIT_REF_NAME}\"" | wc -l`;

# No MR found, let's create a new one
if [ ${COUNTBRANCHES} -eq "0" ]; then
    curl -X POST "${HOST}${CI_PROJECT_ID}/merge_requests" \
    --header "PRIVATE-TOKEN:${PRIVATE_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "${BODY}";

    echo "Opened a new merge request: WIP: ${CI_COMMIT_REF_SLUG} for user ${GITLAB_USER_LOGIN}";
    exit;
fi
    echo "No new merge request opened"


8
投票

简短回答:当然 - 一切皆有可能。 GitLab 有一个很棒的 API(包括创建 MR)。但我认为走这条路是不好的。您应该按照设计的那样使用 GitLab。您开始合并请求的时间太晚了。在开始任何工作之前启动它,您的合并请求将在分支的整个持续时间内保持打开状态。

长答案: 这是理想的 GitLab 工作流程:

  1. 有人针对存储库创建了ISSUE也许是一个功能请求,也许是一个实际问题,无论如何 - 有人想要改变一些东西,所以这是一个“问题”
  2. 开发人员打开问题并单击 CREATE MERGE REQUEST
  • 生成一个合并请求(MR),一个匹配的分支,并将其与问题联系起来
  1. 开发人员在分支上工作,随时推动更改
  2. 开发人员获得传递管道,并在准备好让客户预览工作和/或其他开发人员进行代码审查时,在该合并请求页面上点击“Resolve WIP”。
  3. 从这里开始,让审阅者在完成审阅后单击 MERGE,或者更好的是,在存储库设置中打开 APPROVALS设置您想要审阅的人员或人群。
  4. 在合并按钮旁边,请务必删除源分支(为了保持理智),合并的代码将自动关闭问题 - 并将所有 3 个元素链接在一起。

这从根本上落后于 GitHub 的工作方式(我来自 GitHub),在 GitHub 上你无法告诉人们你正在做什么。

    当工作
  • 完成并且您想要合并到master中时,会创建GitHub上的拉请求
  • GitLab 上的合并请求是在工作“开始”时创建的,并且您想告诉世界您即将开始开发某个功能。这允许人们在不需要时快速关闭或防止多个开发人员重复工作。

编辑:

听起来您对利用 API 很感兴趣。有一个名为“python-gitlab”的Python包实际上可以正常工作http://python-gitlab.readthedocs.io/en/stable/gl_objects/mrs.html import gitlab import os origin = "https://gitlab.example.com" # Private token is set as an env var gl = gitlab.Gitlab(origin, private_token, api_version='4') gl.auth() def create_merge_request(origin, private_token): mr = project.mergerequests.create({'source_branch': 'cool_feature', 'target_branch': 'master', 'title': 'merge cool feature', 'labels': ['label1', 'label2']}) mr.assignee_id = gl.users.get(2).id # Assign it to coworker def lookup_last_pipeline(origin, private_token): current_pipeline_id = os.environ['CI_PIPELINE_ID'] pipelines = gl.projects.get(os.environ['CI_PROJECT_ID']).pipelines.list() for pipeline in pipelines: if pipeline.status == 'success' and pipeline.id == current_pipeline_id: create_merge_request()

这当然是一个示例,您必须根据您的具体需求进行调整。


3
投票

不使用 GitLab API
  • 获取管道检出的代码所代表的补丁
  • 使用电子邮件(!),自 GitLab 11.5(2018 年 11 月)起
通过电子邮件打开带有补丁的合并请求

GitLab 长期以来一直支持通过电子邮件打开合并请求,但在发送电子邮件之前,分支必须已经存在于服务器上。现在,您只需一封电子邮件即可通过附加一个或多个补丁文件来打开合并请求 (

.patch

)。

补丁文件是系统之间共享和传输更改的标准。在 GitLab 的未来版本中,我们将在此基础上构建

分布式合并请求

,这将允许 GitLab 实例和其他 Git 托管工具之间的合并请求。

请参阅
文档

问题

© www.soinside.com 2019 - 2024. All rights reserved.