Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Boxiang Sun
gitlab-ce
Commits
8b5c16e4
Commit
8b5c16e4
authored
8 years ago
by
Robert Schilling
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
API: Ability to remove source branch
parent
bd674591
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
47 additions
and
26 deletions
+47
-26
changelogs/unreleased/api-remove-source-branch.yml
changelogs/unreleased/api-remove-source-branch.yml
+4
-0
doc/api/merge_requests.md
doc/api/merge_requests.md
+26
-23
lib/api/merge_requests.rb
lib/api/merge_requests.rb
+6
-2
spec/requests/api/merge_requests_spec.rb
spec/requests/api/merge_requests_spec.rb
+11
-1
No files found.
changelogs/unreleased/api-remove-source-branch.yml
0 → 100644
View file @
8b5c16e4
---
title
:
'
API:
Ability
to
set
'
'
should_remove_source_branch'
'
on
merge
requests'
merge_request
:
author
:
Robert Schilling
This diff is collapsed.
Click to expand it.
doc/api/merge_requests.md
View file @
8b5c16e4
...
...
@@ -271,17 +271,18 @@ Creates a new merge request.
POST /projects/:id/merge_requests
```
Parameters:
-
`id`
(required) - The ID of a project
-
`source_branch`
(required) - The source branch
-
`target_branch`
(required) - The target branch
-
`assignee_id`
(optional) - Assignee user ID
-
`title`
(required) - Title of MR
-
`description`
(optional) - Description of MR
-
`target_project_id`
(optional) - The target project (numeric id)
-
`labels`
(optional) - Labels for MR as a comma-separated list
-
`milestone_id`
(optional) - Milestone ID
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
|
`id`
| string | yes | The ID of a project |
|
`source_branch`
| string | yes | The source branch |
|
`target_branch`
| string | yes | The target branch |
|
`title`
| string | yes | Title of MR |
|
`assignee_id`
| integer | no | Assignee user ID |
|
`description`
| string | no | Description of MR |
|
`target_project_id`
| integer | no | The target project (numeric id) |
|
`labels`
| string | no | Labels for MR as a comma-separated list |
|
`milestone_id`
| integer | no | The ID of a milestone |
|
`remove_source_branch`
| boolean | no | Flag indicating if a merge request should remove the source branch when merging |
```
json
{
...
...
@@ -346,17 +347,19 @@ Updates an existing merge request. You can change the target branch, title, or e
PUT /projects/:id/merge_requests/:merge_request_id
```
Parameters:
-
`id`
(required) - The ID of a project
-
`merge_request_id`
(required) - ID of MR
-
`target_branch`
- The target branch
-
`assignee_id`
- Assignee user ID
-
`title`
- Title of MR
-
`description`
- Description of MR
-
`state_event`
- New state (close|reopen|merge)
-
`labels`
(optional) - Labels for MR as a comma-separated list
-
`milestone_id`
(optional) - Milestone ID
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
|
`id`
| string | yes | The ID of a project |
|
`merge_request_id`
| integer | yes | The ID of a merge request |
|
`source_branch`
| string | yes | The source branch |
|
`target_branch`
| string | yes | The target branch |
|
`title`
| string | yes | Title of MR |
|
`assignee_id`
| integer | no | Assignee user ID |
|
`description`
| string | no | Description of MR |
|
`target_project_id`
| integer | no | The target project (numeric id) |
|
`labels`
| string | no | Labels for MR as a comma-separated list |
|
`milestone_id`
| integer | no | The ID of a milestone |
|
`remove_source_branch`
| boolean | no | Flag indicating if a merge request should remove the source branch when merging |
```
json
{
...
...
@@ -807,7 +810,7 @@ Example response:
## Create a todo
Manually creates a todo for the current user on a merge request.
Manually creates a todo for the current user on a merge request.
If there already exists a todo for the user on that merge request,
status code
`304`
is returned.
...
...
This diff is collapsed.
Click to expand it.
lib/api/merge_requests.rb
View file @
8b5c16e4
...
...
@@ -28,6 +28,7 @@ module API
optional
:assignee_id
,
type:
Integer
,
desc:
'The ID of a user to assign the merge request'
optional
:milestone_id
,
type:
Integer
,
desc:
'The ID of a milestone to assign the merge request'
optional
:labels
,
type:
String
,
desc:
'Comma-separated list of label names'
optional
:remove_source_branch
,
type:
Boolean
,
desc:
'Remove source branch when merging'
end
end
...
...
@@ -75,7 +76,8 @@ module API
post
":id/merge_requests"
do
authorize!
:create_merge_request
,
user_project
mr_params
=
declared_params
mr_params
=
declared_params
(
include_missing:
false
)
mr_params
[
:force_remove_source_branch
]
=
mr_params
.
delete
(
:remove_source_branch
)
if
mr_params
[
:remove_source_branch
].
present?
merge_request
=
::
MergeRequests
::
CreateService
.
new
(
user_project
,
current_user
,
mr_params
).
execute
...
...
@@ -144,13 +146,15 @@ module API
desc:
'Status of the merge request'
use
:optional_params
at_least_one_of
:title
,
:target_branch
,
:description
,
:assignee_id
,
:milestone_id
,
:labels
,
:state_event
:milestone_id
,
:labels
,
:state_event
,
:remove_source_branch
end
put
path
do
merge_request
=
user_project
.
merge_requests
.
find
(
params
.
delete
(
:merge_request_id
))
authorize!
:update_merge_request
,
merge_request
mr_params
=
declared_params
(
include_missing:
false
)
mr_params
[
:force_remove_source_branch
]
=
mr_params
.
delete
(
:remove_source_branch
)
if
mr_params
[
:remove_source_branch
].
present?
merge_request
=
::
MergeRequests
::
UpdateService
.
new
(
user_project
,
current_user
,
mr_params
).
execute
(
merge_request
)
...
...
This diff is collapsed.
Click to expand it.
spec/requests/api/merge_requests_spec.rb
View file @
8b5c16e4
...
...
@@ -234,11 +234,14 @@ describe API::MergeRequests, api: true do
target_branch:
'master'
,
author:
user
,
labels:
'label, label2'
,
milestone_id:
milestone
.
id
milestone_id:
milestone
.
id
,
remove_source_branch:
true
expect
(
response
).
to
have_http_status
(
201
)
expect
(
json_response
[
'title'
]).
to
eq
(
'Test merge_request'
)
expect
(
json_response
[
'labels'
]).
to
eq
([
'label'
,
'label2'
])
expect
(
json_response
[
'milestone'
][
'id'
]).
to
eq
(
milestone
.
id
)
expect
(
json_response
[
'force_remove_source_branch'
]).
to
be_truthy
end
it
"returns 422 when source_branch equals target_branch"
do
...
...
@@ -511,6 +514,13 @@ describe API::MergeRequests, api: true do
expect
(
json_response
[
'target_branch'
]).
to
eq
(
'wiki'
)
end
it
"returns merge_request that removes the source branch"
do
put
api
(
"/projects/
#{
project
.
id
}
/merge_requests/
#{
merge_request
.
id
}
"
,
user
),
remove_source_branch:
true
expect
(
response
).
to
have_http_status
(
200
)
expect
(
json_response
[
'force_remove_source_branch'
]).
to
be_truthy
end
it
'allows special label names'
do
put
api
(
"/projects/
#{
project
.
id
}
/merge_requests/
#{
merge_request
.
id
}
"
,
user
),
title:
'new issue'
,
...
...
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment