通过并合并评审。
MergeMergeRequest
该接口用于通过并合并代码评审。
请求方式:PUT/api/v3/projects/[ProjectId]/merge_request/[MergeRequestId]/merge
请求Action:MergeMergeRequest
请求参数:
参数名 | 类型 | 说明 | 是否必须 | 默认值 |
ProjectId | long | 代码库 ID | 是 | |
MergeRequestId | long | 合并请求id | 是 |
请求 body:
{
"merge_commit_message": "string",
"should_remove_source_branch": false,
"source_branch_revision": "string",
"merge_type": "string"
}
body参数说明:
参数名 | 类型 | 说明 | 是否必须 | 默认值 |
merge_commit_message | string | 合并提交信息 | 是 | |
source_branch_revision | string | 合并时评审分支版本 | 是 | |
merge_type | string | 合并类型 | 是 | 可选:
|
should_remove_source_branch | string | 是否在合并后删除评审分支 | 是 |
返回结果:
{
"ErrorCode": "",
"ErrorMessage": "",
"RequestId": "",
"Success":true,
"Result": {
"Id": 1,
"ProjectId": 1,
"Title": "Feature xxx",
"Description": "Create MergeRequest",
"State": "merged",
"MergeStatus": "can_be_merged",
"CreatedAt": "2020-09-07T17:45:44+08:00",
"UpdatedAt": "2020-09-07T17:45:44+08:00",
"TargetBranch": "master",
"SourceBranch": "feature1",
"WebUrl": "https://codeup.aliyun.com/5ef0767baf80fad018f11bfa/3t97u7e6",
"AcceptedRevision": "0a53648d38f9b28a9551673881316bf9f25767c7",
"MergeError": "",
"MergedRevision": "e39c011adcc6ad2c45c3087d6e0489125c0aa9a0",
"NameWithNamespace": "5ef0767baf80fad018f11bfa / 3t97u7e6";
"MergeType": "no-fast-forward",
"AheadCommitCount": 0,
"BehindCommitCount": 1,
"AssigneeList": [],
"Author": {
"Id": 1,
"ExternUserId": "5e74b41c0328383328529198",
"AvatarUrl": "",
"Name": ""
},
"ApproveCheckResult": {}
}
}
返回结果说明:
参数名 | 类型 | 说明 |
Id | long | 合并请求id |
ProjectId | long | 代码库id |
Title | string | 合并请求标题 |
Description | string | 合并请求描述 |
State | string | 合并请求状态, 包括:打开的(opened,reopened)、关闭的(closed)、评审通过(未合并,accepted),评审通过(已合并,merged),合并中(locked) |
MergeStatus | string | 合并请求合并状态,包括:未检查(unchecked)、可以合并(can_be_merged)、不可以合并(cannot_be_merged) |
CreatedAt | string | 创建时间 |
UpdatedAt | string | 更新时间 |
SourceBranch | string | 源分支 |
TargetBranch | string | 目标分支 |
WebUrl | string | Web地址 |
AcceptedRevision | string | 评审通过时的版本 |
MergeError | string | 合并异常信息 |
MergedRevision | string | 合并版本 |
NameWithNamespace | string | 名称(含父路径) |
MergeType | string | 合并方式 |
AheadCommitCount | string | 源分支先于目标分支的commit数量 |
BehindCommitCount | string | 目标分支先于源分支的commit数量 |
AssigneeList | Assignee list | 评审人列表 |
Author | struct | 创建者 |
ApproveCheckResult | struct | 卡点详情 |
Assignee、Author、UserBasic结构:
参数名 | 类型 | 说明 |
Id | long | Codeup 用户id |
ExternUserId | string | 云效用户id |
AvatarUrl | string | 用户头像地址 |
Name | string | 用户姓名 |
ApproveCheckResult结构:
参数名 | 类型 | 说明 |
TotalCheckResult | string | 总体检查结果: SATISFIED,UNSATISFIED |
SatisfiedCheckResults | list CheckResult | 通过的卡点 |
UnsatisfedCheckResults | list CheckResult | 未通过的卡点 |
CheckResults结构:
参数名 | 类型 | 说明 |
CheckStatus | string | 卡点状态: SATISFIED,UNSATISFIED |
CheckName | string | 卡点名称 |
SatisfiedItems | list string | 满足条件的子项 |
UnsatisfiedItems | list string | 不满足条件的子项 |
CheckType | string | 卡点类型 |
ExtraUsers | list UserBasic | 人员信息 |