debian-mirror-gitlab/lib/api/merge_requests.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

568 lines
24 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
module API
2021-01-03 14:25:43 +05:30
class MergeRequests < ::API::Base
2017-08-17 22:00:37 +05:30
include PaginationParams
2020-03-13 15:44:24 +05:30
CONTEXT_COMMITS_POST_LIMIT = 20
2018-03-17 18:26:18 +05:30
before { authenticate_non_get! }
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
helpers Helpers::MergeRequestsHelpers
2017-09-10 17:25:29 +05:30
2021-04-29 21:17:54 +05:30
# These endpoints are defined in `TimeTrackingEndpoints` and is shared by
# API::Issues. In order to be able to define the feature category of these
# endpoints, we need to define them at the top-level by route.
feature_category :code_review, [
'/projects/:id/merge_requests/:merge_request_iid/time_estimate',
'/projects/:id/merge_requests/:merge_request_iid/reset_time_estimate',
'/projects/:id/merge_requests/:merge_request_iid/add_spent_time',
'/projects/:id/merge_requests/:merge_request_iid/reset_spent_time',
'/projects/:id/merge_requests/:merge_request_iid/time_stats'
]
2018-03-27 19:54:05 +05:30
# EE::API::MergeRequests would override the following helpers
helpers do
params :optional_params_ee do
end
2019-07-07 11:18:12 +05:30
params :optional_merge_requests_search_params do
end
2018-03-27 19:54:05 +05:30
end
def self.update_params_at_least_one_of
%i[
assignee_id
2019-07-31 22:56:46 +05:30
assignee_ids
2021-03-11 19:13:27 +05:30
reviewer_ids
2018-03-27 19:54:05 +05:30
description
labels
2020-05-24 23:13:21 +05:30
add_labels
remove_labels
2018-03-27 19:54:05 +05:30
milestone_id
remove_source_branch
2020-11-24 15:15:51 +05:30
allow_collaboration
allow_maintainer_to_push
squash
2018-03-27 19:54:05 +05:30
target_branch
title
2020-11-24 15:15:51 +05:30
state_event
2018-03-27 19:54:05 +05:30
discussion_locked
]
end
2021-06-08 01:23:25 +05:30
prepend_mod_with('API::MergeRequests') # rubocop: disable Cop/InjectEnterpriseEditionModule
2019-12-04 20:38:33 +05:30
2017-09-10 17:25:29 +05:30
helpers do
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2017-09-10 17:25:29 +05:30
def find_merge_requests(args = {})
2018-03-17 18:26:18 +05:30
args = declared_params.merge(args)
2017-09-10 17:25:29 +05:30
args[:milestone_title] = args.delete(:milestone)
2020-07-28 23:09:34 +05:30
args[:not][:milestone_title] = args[:not]&.delete(:milestone)
2017-09-10 17:25:29 +05:30
args[:label_name] = args.delete(:labels)
2020-07-28 23:09:34 +05:30
args[:not][:label_name] = args[:not]&.delete(:labels)
2018-11-08 19:23:39 +05:30
args[:scope] = args[:scope].underscore if args[:scope]
2017-09-10 17:25:29 +05:30
merge_requests = MergeRequestsFinder.new(current_user, args).execute
2019-07-07 11:18:12 +05:30
.reorder(order_options_with_tie_breaker)
2017-09-10 17:25:29 +05:30
merge_requests = paginate(merge_requests)
2018-11-08 19:23:39 +05:30
.preload(:source_project, :target_project)
2017-09-10 17:25:29 +05:30
return merge_requests if args[:view] == 'simple'
merge_requests
2019-07-07 11:18:12 +05:30
.with_api_entity_associations
2018-03-17 18:26:18 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2018-03-17 18:26:18 +05:30
def merge_request_pipelines_with_access
mr = find_merge_request_with_access(params[:merge_request_iid])
2020-07-28 23:09:34 +05:30
::Ci::PipelinesForMergeRequestFinder.new(mr, current_user).execute
2018-03-27 19:54:05 +05:30
end
2020-03-13 15:44:24 +05:30
def automatically_mergeable?(merge_when_pipeline_succeeds, merge_request)
pipeline_active = merge_request.head_pipeline_active? || merge_request.actual_head_pipeline_active?
merge_when_pipeline_succeeds && merge_request.mergeable_state?(skip_ci_check: true) && pipeline_active
end
def immediately_mergeable?(merge_when_pipeline_succeeds, merge_request)
if merge_when_pipeline_succeeds
merge_request.actual_head_pipeline_success?
else
merge_request.mergeable_state?
end
2020-01-01 13:55:28 +05:30
end
2018-11-08 19:23:39 +05:30
def serializer_options_for(merge_requests)
2020-03-13 15:44:24 +05:30
options = { with: Entities::MergeRequestBasic, current_user: current_user, with_labels_details: declared_params[:with_labels_details] }
2018-11-08 19:23:39 +05:30
if params[:view] == 'simple'
options[:with] = Entities::MergeRequestSimple
else
2020-06-23 00:09:42 +05:30
options[:skip_merge_status_recheck] = !declared_params[:with_merge_status_recheck]
2018-11-08 19:23:39 +05:30
end
options
end
2019-02-15 15:39:39 +05:30
def authorize_push_to_merge_request!(merge_request)
forbidden!('Source branch does not exist') unless
merge_request.source_branch_exists?
user_access = Gitlab::UserAccess.new(
current_user,
2020-10-24 23:57:45 +05:30
container: merge_request.source_project
2019-02-15 15:39:39 +05:30
)
forbidden!('Cannot push to source branch') unless
user_access.can_push_to_branch?(merge_request.source_branch)
2022-04-04 11:22:00 +05:30
forbidden!('Source branch is protected from force push') unless
merge_request.permits_force_push?
2019-02-15 15:39:39 +05:30
end
2022-08-27 11:52:29 +05:30
def recheck_mergeability_of(merge_requests:)
merge_requests.each { |mr| mr.check_mergeability(async: true) }
end
2017-09-10 17:25:29 +05:30
params :merge_requests_params do
2020-03-13 15:44:24 +05:30
use :merge_requests_base_params
2019-07-07 11:18:12 +05:30
use :optional_merge_requests_search_params
2017-09-10 17:25:29 +05:30
use :pagination
end
end
resource :merge_requests do
desc 'List merge requests' do
success Entities::MergeRequestBasic
end
params do
use :merge_requests_params
2020-03-13 15:44:24 +05:30
use :optional_scope_param
2017-09-10 17:25:29 +05:30
end
2022-01-26 12:08:38 +05:30
get feature_category: :code_review, urgency: :low do
2018-03-17 18:26:18 +05:30
authenticate! unless params[:scope] == 'all'
2021-11-18 22:05:49 +05:30
validate_anonymous_search_access! if params[:search].present?
2017-09-10 17:25:29 +05:30
merge_requests = find_merge_requests
2018-11-08 19:23:39 +05:30
present merge_requests, serializer_options_for(merge_requests)
end
end
2017-09-10 17:25:29 +05:30
2018-11-08 19:23:39 +05:30
params do
requires :id, type: String, desc: 'The ID of a group'
end
2019-02-15 15:39:39 +05:30
resource :groups, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
2018-11-08 19:23:39 +05:30
desc 'Get a list of group merge requests' do
success Entities::MergeRequestBasic
end
params do
use :merge_requests_params
2020-03-13 15:44:24 +05:30
optional :non_archived, type: Boolean, desc: 'Return merge requests from non archived projects',
2022-08-27 11:52:29 +05:30
default: true
2018-11-08 19:23:39 +05:30
end
2022-01-26 12:08:38 +05:30
get ":id/merge_requests", feature_category: :code_review, urgency: :low do
2021-11-18 22:05:49 +05:30
validate_anonymous_search_access! if declared_params[:search].present?
2020-03-13 15:44:24 +05:30
merge_requests = find_merge_requests(group_id: user_group.id, include_subgroups: true)
2017-09-10 17:25:29 +05:30
2020-03-13 15:44:24 +05:30
present merge_requests, serializer_options_for(merge_requests).merge(group: user_group)
2017-09-10 17:25:29 +05:30
end
end
2017-08-17 22:00:37 +05:30
params do
requires :id, type: String, desc: 'The ID of a project'
end
2019-02-15 15:39:39 +05:30
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
2017-08-17 22:00:37 +05:30
include TimeTrackingEndpoints
2014-09-02 18:07:02 +05:30
helpers do
2018-03-27 19:54:05 +05:30
params :optional_params do
2017-08-17 22:00:37 +05:30
optional :assignee_id, type: Integer, desc: 'The ID of a user to assign the merge request'
2021-03-11 19:13:27 +05:30
optional :assignee_ids, type: Array[Integer], coerce_with: ::API::Validations::Types::CommaSeparatedToIntegerArray.coerce, desc: 'Comma-separated list of assignee ids'
optional :reviewer_ids, type: Array[Integer], coerce_with: ::API::Validations::Types::CommaSeparatedToIntegerArray.coerce, desc: 'Comma-separated list of reviewer ids'
2020-11-24 15:15:51 +05:30
optional :description, type: String, desc: 'The description of the merge request'
2020-07-28 23:09:34 +05:30
optional :labels, type: Array[String], coerce_with: Validations::Types::CommaSeparatedToArray.coerce, desc: 'Comma-separated list of label names'
optional :add_labels, type: Array[String], coerce_with: Validations::Types::CommaSeparatedToArray.coerce, desc: 'Comma-separated list of label names'
optional :remove_labels, type: Array[String], coerce_with: Validations::Types::CommaSeparatedToArray.coerce, desc: 'Comma-separated list of label names'
2020-11-24 15:15:51 +05:30
optional :milestone_id, type: Integer, desc: 'The ID of a milestone to assign the merge request'
2019-07-07 11:18:12 +05:30
optional :remove_source_branch, type: Boolean, desc: 'Remove source branch when merging'
2018-11-08 19:23:39 +05:30
optional :allow_collaboration, type: Boolean, desc: 'Allow commits from members who can merge to the target branch'
optional :allow_maintainer_to_push, type: Boolean, as: :allow_collaboration, desc: '[deprecated] See allow_collaboration'
optional :squash, type: Grape::API::Boolean, desc: 'When true, the commits will be squashed into a single commit on merge'
2017-08-17 22:00:37 +05:30
2018-03-27 19:54:05 +05:30
use :optional_params_ee
2017-08-17 22:00:37 +05:30
end
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'List merge requests' do
success Entities::MergeRequestBasic
end
params do
2017-09-10 17:25:29 +05:30
use :merge_requests_params
2020-07-28 23:09:34 +05:30
optional :iids, type: Array[Integer], coerce_with: ::API::Validations::Types::CommaSeparatedToIntegerArray.coerce, desc: 'The IID array of merge requests'
2017-08-17 22:00:37 +05:30
end
2022-01-26 12:08:38 +05:30
get ":id/merge_requests", feature_category: :code_review, urgency: :low do
2014-09-02 18:07:02 +05:30
authorize! :read_merge_request, user_project
2021-11-18 22:05:49 +05:30
validate_anonymous_search_access! if declared_params[:search].present?
2015-04-26 12:48:37 +05:30
2017-08-17 22:00:37 +05:30
merge_requests = find_merge_requests(project_id: user_project.id)
2015-09-11 14:41:01 +05:30
2020-03-13 15:44:24 +05:30
options = serializer_options_for(merge_requests).merge(project: user_project)
2018-11-08 19:23:39 +05:30
options[:project] = user_project
2017-09-10 17:25:29 +05:30
2022-08-27 11:52:29 +05:30
recheck_mergeability_of(merge_requests: merge_requests) unless options[:skip_merge_status_recheck]
present_cached merge_requests, expires_in: 8.hours, cache_context: -> (mr) { "#{current_user&.cache_key}:#{mr.merge_status}" }, **options
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Create a merge request' do
success Entities::MergeRequest
end
params do
requires :title, type: String, desc: 'The title of the merge request'
requires :source_branch, type: String, desc: 'The source branch'
requires :target_branch, type: String, desc: 'The target branch'
optional :target_project_id, type: Integer,
desc: 'The target project of the merge request defaults to the :id of the project'
use :optional_params
end
2022-01-26 12:08:38 +05:30
post ":id/merge_requests", feature_category: :code_review, urgency: :low do
2021-04-29 21:17:54 +05:30
Gitlab::QueryLimiting.disable!('https://gitlab.com/gitlab-org/gitlab/-/issues/20770')
2018-03-17 18:26:18 +05:30
2018-05-09 12:01:36 +05:30
authorize! :create_merge_request_from, user_project
2014-09-02 18:07:02 +05:30
2017-08-17 22:00:37 +05:30
mr_params = declared_params(include_missing: false)
2017-09-10 17:25:29 +05:30
mr_params[:force_remove_source_branch] = mr_params.delete(:remove_source_branch)
2019-07-31 22:56:46 +05:30
mr_params = convert_parameters_from_legacy_format(mr_params)
2016-11-03 12:29:30 +05:30
2021-06-08 01:23:25 +05:30
merge_request = ::MergeRequests::CreateService.new(project: user_project, current_user: current_user, params: mr_params).execute
2014-09-02 18:07:02 +05:30
2020-10-24 23:57:45 +05:30
handle_merge_request_errors!(merge_request)
present merge_request, with: Entities::MergeRequest, current_user: current_user, project: user_project
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Delete a merge request'
params do
requires :merge_request_iid, type: Integer, desc: 'The IID of a merge request'
end
2022-01-26 12:08:38 +05:30
delete ":id/merge_requests/:merge_request_iid", feature_category: :code_review, urgency: :low do
2017-08-17 22:00:37 +05:30
merge_request = find_project_merge_request(params[:merge_request_iid])
2016-06-02 11:05:42 +05:30
authorize!(:destroy_merge_request, merge_request)
2018-03-17 18:26:18 +05:30
destroy_conditionally!(merge_request) do |merge_request|
2021-06-08 01:23:25 +05:30
Issuable::DestroyService.new(project: user_project, current_user: current_user).execute(merge_request)
2018-03-17 18:26:18 +05:30
end
2016-06-02 11:05:42 +05:30
end
2017-01-15 13:20:01 +05:30
params do
2017-08-17 22:00:37 +05:30
requires :merge_request_iid, type: Integer, desc: 'The IID of a merge request'
2018-11-08 19:23:39 +05:30
optional :render_html, type: Boolean, desc: 'Returns the description and title rendered HTML'
2018-11-20 20:47:30 +05:30
optional :include_diverged_commits_count, type: Boolean, desc: 'Returns the commits count behind the target branch'
2019-02-15 15:39:39 +05:30
optional :include_rebase_in_progress, type: Boolean, desc: 'Returns whether a rebase operation is ongoing '
2017-01-15 13:20:01 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Get a single merge request' do
success Entities::MergeRequest
end
2022-01-26 12:08:38 +05:30
get ':id/merge_requests/:merge_request_iid', feature_category: :code_review, urgency: :low do
2017-08-17 22:00:37 +05:30
merge_request = find_merge_request_with_access(params[:merge_request_iid])
2014-09-02 18:07:02 +05:30
2019-02-15 15:39:39 +05:30
present merge_request,
with: Entities::MergeRequest,
current_user: current_user,
project: user_project,
render_html: params[:render_html],
2020-04-22 19:07:51 +05:30
include_first_contribution: true,
2019-02-15 15:39:39 +05:30
include_diverged_commits_count: params[:include_diverged_commits_count],
include_rebase_in_progress: params[:include_rebase_in_progress]
2017-08-17 22:00:37 +05:30
end
2015-12-23 02:04:40 +05:30
2018-03-17 18:26:18 +05:30
desc 'Get the participants of a merge request' do
success Entities::UserBasic
end
2022-01-26 12:08:38 +05:30
get ':id/merge_requests/:merge_request_iid/participants', feature_category: :code_review, urgency: :low do
2018-03-17 18:26:18 +05:30
merge_request = find_merge_request_with_access(params[:merge_request_iid])
2021-02-11 23:33:58 +05:30
2022-01-26 12:08:38 +05:30
participants = ::Kaminari.paginate_array(merge_request.visible_participants(current_user))
2018-03-17 18:26:18 +05:30
present paginate(participants), with: Entities::UserBasic
end
2022-08-27 11:52:29 +05:30
desc 'Get the reviewers of a merge request' do
success Entities::MergeRequestReviewer
end
get ':id/merge_requests/:merge_request_iid/reviewers', feature_category: :code_review, urgency: :low do
merge_request = find_merge_request_with_access(params[:merge_request_iid])
reviewers = ::Kaminari.paginate_array(merge_request.merge_request_reviewers)
present paginate(reviewers), with: Entities::MergeRequestReviewer
end
2017-08-17 22:00:37 +05:30
desc 'Get the commits of a merge request' do
2018-03-17 18:26:18 +05:30
success Entities::Commit
2017-08-17 22:00:37 +05:30
end
2022-01-26 12:08:38 +05:30
get ':id/merge_requests/:merge_request_iid/commits', feature_category: :code_review, urgency: :low do
2017-08-17 22:00:37 +05:30
merge_request = find_merge_request_with_access(params[:merge_request_iid])
2015-12-23 02:04:40 +05:30
2019-12-26 22:10:19 +05:30
commits =
paginate(merge_request.merge_request_diff.merge_request_diff_commits)
.map { |commit| Commit.from_hash(commit.to_hash, merge_request.project) }
present commits, with: Entities::Commit
2017-08-17 22:00:37 +05:30
end
2016-04-02 18:10:28 +05:30
2020-03-13 15:44:24 +05:30
desc 'Get the context commits of a merge request' do
success Entities::Commit
end
2022-01-26 12:08:38 +05:30
get ':id/merge_requests/:merge_request_iid/context_commits', feature_category: :code_review, urgency: :high do
2020-03-13 15:44:24 +05:30
merge_request = find_merge_request_with_access(params[:merge_request_iid])
context_commits =
paginate(merge_request.merge_request_context_commits).map(&:to_commit)
2020-04-22 19:07:51 +05:30
present context_commits, with: Entities::CommitWithLink, type: :full, request: merge_request
2020-03-13 15:44:24 +05:30
end
params do
2020-07-28 23:09:34 +05:30
requires :commits, type: Array[String], coerce_with: ::API::Validations::Types::CommaSeparatedToArray.coerce, allow_blank: false, desc: 'List of context commits sha'
2020-03-13 15:44:24 +05:30
end
desc 'create context commits of merge request' do
success Entities::Commit
end
2021-04-29 21:17:54 +05:30
post ':id/merge_requests/:merge_request_iid/context_commits', feature_category: :code_review do
2020-03-13 15:44:24 +05:30
commit_ids = params[:commits]
if commit_ids.size > CONTEXT_COMMITS_POST_LIMIT
render_api_error!("Context commits array size should not be more than #{CONTEXT_COMMITS_POST_LIMIT}", 400)
end
merge_request = find_merge_request_with_access(params[:merge_request_iid])
authorize!(:update_merge_request, merge_request)
project = merge_request.target_project
2021-06-08 01:23:25 +05:30
result = ::MergeRequests::AddContextService.new(project: project, current_user: current_user, params: { merge_request: merge_request, commits: commit_ids }).execute
2020-03-13 15:44:24 +05:30
if result.instance_of?(Array)
present result, with: Entities::Commit
else
render_api_error!(result[:message], result[:http_status])
end
end
params do
2020-07-28 23:09:34 +05:30
requires :commits, type: Array[String], coerce_with: ::API::Validations::Types::CommaSeparatedToArray.coerce, allow_blank: false, desc: 'List of context commits sha'
2020-03-13 15:44:24 +05:30
end
desc 'remove context commits of merge request'
2021-04-29 21:17:54 +05:30
delete ':id/merge_requests/:merge_request_iid/context_commits', feature_category: :code_review do
2020-03-13 15:44:24 +05:30
commit_ids = params[:commits]
merge_request = find_merge_request_with_access(params[:merge_request_iid])
authorize!(:destroy_merge_request, merge_request)
project = merge_request.target_project
commits = project.repository.commits_by(oids: commit_ids)
if commits.size != commit_ids.size
render_api_error!("One or more context commits' sha is not valid.", 400)
end
MergeRequestContextCommit.delete_bulk(merge_request, commits)
status 204
end
2017-08-17 22:00:37 +05:30
desc 'Show the merge request changes' do
success Entities::MergeRequestChanges
end
2022-01-26 12:08:38 +05:30
get ':id/merge_requests/:merge_request_iid/changes', feature_category: :code_review, urgency: :low do
2017-08-17 22:00:37 +05:30
merge_request = find_merge_request_with_access(params[:merge_request_iid])
2014-09-02 18:07:02 +05:30
2021-01-29 00:20:46 +05:30
present merge_request,
with: Entities::MergeRequestChanges,
current_user: current_user,
project: user_project,
2021-03-11 19:13:27 +05:30
access_raw_diffs: to_boolean(params.fetch(:access_raw_diffs, false))
2017-08-17 22:00:37 +05:30
end
2016-11-03 12:29:30 +05:30
2018-03-17 18:26:18 +05:30
desc 'Get the merge request pipelines' do
2020-10-24 23:57:45 +05:30
success Entities::Ci::PipelineBasic
2018-03-17 18:26:18 +05:30
end
2022-07-16 23:28:13 +05:30
get ':id/merge_requests/:merge_request_iid/pipelines', urgency: :low, feature_category: :continuous_integration do
2018-03-17 18:26:18 +05:30
pipelines = merge_request_pipelines_with_access
2020-10-24 23:57:45 +05:30
present paginate(pipelines), with: Entities::Ci::PipelineBasic
2018-03-17 18:26:18 +05:30
end
2019-12-04 20:38:33 +05:30
desc 'Create a pipeline for merge request' do
2020-10-24 23:57:45 +05:30
success ::API::Entities::Ci::Pipeline
2019-12-04 20:38:33 +05:30
end
2022-07-16 23:28:13 +05:30
post ':id/merge_requests/:merge_request_iid/pipelines', urgency: :low, feature_category: :continuous_integration do
2019-12-04 20:38:33 +05:30
pipeline = ::MergeRequests::CreatePipelineService
2021-06-08 01:23:25 +05:30
.new(project: user_project, current_user: current_user, params: { allow_duplicate: true })
2019-12-04 20:38:33 +05:30
.execute(find_merge_request_with_access(params[:merge_request_iid]))
2021-10-27 15:23:28 +05:30
.payload
2019-12-04 20:38:33 +05:30
if pipeline.nil?
not_allowed!
elsif pipeline.persisted?
status :ok
2020-10-24 23:57:45 +05:30
present pipeline, with: ::API::Entities::Ci::Pipeline
2019-12-04 20:38:33 +05:30
else
render_validation_error!(pipeline)
end
end
2017-08-17 22:00:37 +05:30
desc 'Update a merge request' do
success Entities::MergeRequest
end
params do
optional :title, type: String, allow_blank: false, desc: 'The title of the merge request'
optional :target_branch, type: String, allow_blank: false, desc: 'The target branch'
optional :state_event, type: String, values: %w[close reopen],
desc: 'Status of the merge request'
2018-03-17 18:26:18 +05:30
optional :discussion_locked, type: Boolean, desc: 'Whether the MR discussion is locked'
2017-08-17 22:00:37 +05:30
use :optional_params
2018-03-27 19:54:05 +05:30
at_least_one_of(*::API::MergeRequests.update_params_at_least_one_of)
2017-08-17 22:00:37 +05:30
end
2022-01-26 12:08:38 +05:30
put ':id/merge_requests/:merge_request_iid', feature_category: :code_review, urgency: :low do
2021-04-29 21:17:54 +05:30
Gitlab::QueryLimiting.disable!('https://gitlab.com/gitlab-org/gitlab/-/issues/20772')
2018-03-17 18:26:18 +05:30
2017-08-17 22:00:37 +05:30
merge_request = find_merge_request_with_access(params.delete(:merge_request_iid), :update_merge_request)
2015-12-23 02:04:40 +05:30
2017-08-17 22:00:37 +05:30
mr_params = declared_params(include_missing: false)
2019-07-07 11:18:12 +05:30
mr_params[:force_remove_source_branch] = mr_params.delete(:remove_source_branch) if mr_params.has_key?(:remove_source_branch)
2019-07-31 22:56:46 +05:30
mr_params = convert_parameters_from_legacy_format(mr_params)
2021-09-04 01:27:46 +05:30
mr_params[:use_specialized_service] = true
2014-09-02 18:07:02 +05:30
2021-09-04 01:27:46 +05:30
merge_request = ::MergeRequests::UpdateService
.new(project: user_project, current_user: current_user, params: mr_params)
.execute(merge_request)
2016-04-02 18:10:28 +05:30
2020-10-24 23:57:45 +05:30
handle_merge_request_errors!(merge_request)
present merge_request, with: Entities::MergeRequest, current_user: current_user, project: user_project
2017-08-17 22:00:37 +05:30
end
2016-04-02 18:10:28 +05:30
2017-08-17 22:00:37 +05:30
desc 'Merge a merge request' do
success Entities::MergeRequest
end
params do
optional :merge_commit_message, type: String, desc: 'Custom merge commit message'
2019-03-02 22:35:43 +05:30
optional :squash_commit_message, type: String, desc: 'Custom squash commit message'
2017-08-17 22:00:37 +05:30
optional :should_remove_source_branch, type: Boolean,
desc: 'When true, the source branch will be deleted if possible'
optional :merge_when_pipeline_succeeds, type: Boolean,
desc: 'When true, this merge request will be merged when the pipeline succeeds'
optional :sha, type: String, desc: 'When present, must have the HEAD SHA of the source branch'
2018-11-08 19:23:39 +05:30
optional :squash, type: Grape::API::Boolean, desc: 'When true, the commits will be squashed into a single commit on merge'
2017-08-17 22:00:37 +05:30
end
2022-01-26 12:08:38 +05:30
put ':id/merge_requests/:merge_request_iid/merge', feature_category: :code_review, urgency: :low do
2021-04-29 21:17:54 +05:30
Gitlab::QueryLimiting.disable!('https://gitlab.com/gitlab-org/gitlab/-/issues/4796')
2018-03-17 18:26:18 +05:30
2017-08-17 22:00:37 +05:30
merge_request = find_project_merge_request(params[:merge_request_iid])
2014-09-02 18:07:02 +05:30
2017-08-17 22:00:37 +05:30
# Merge request can not be merged
# because user dont have permissions to push into target branch
unauthorized! unless merge_request.can_be_merged_by?(current_user)
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
merge_when_pipeline_succeeds = to_boolean(params[:merge_when_pipeline_succeeds])
automatically_mergeable = automatically_mergeable?(merge_when_pipeline_succeeds, merge_request)
immediately_mergeable = immediately_mergeable?(merge_when_pipeline_succeeds, merge_request)
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
not_allowed! if !immediately_mergeable && !automatically_mergeable
2022-08-27 11:52:29 +05:30
render_api_error!('Branch cannot be merged', 422) unless merge_request.mergeable?(skip_ci_check: automatically_mergeable)
2015-10-24 18:46:33 +05:30
2018-03-27 19:54:05 +05:30
check_sha_param!(params, merge_request)
2018-11-08 19:23:39 +05:30
merge_request.update(squash: params[:squash]) if params[:squash]
2015-10-24 18:46:33 +05:30
2019-07-07 11:18:12 +05:30
merge_params = HashWithIndifferentAccess.new(
2017-08-17 22:00:37 +05:30
commit_message: params[:merge_commit_message],
2019-03-02 22:35:43 +05:30
squash_commit_message: params[:squash_commit_message],
2019-12-26 22:10:19 +05:30
should_remove_source_branch: params[:should_remove_source_branch],
sha: params[:sha] || merge_request.diff_head_sha
2020-06-23 00:09:42 +05:30
).compact
2015-10-24 18:46:33 +05:30
2020-03-13 15:44:24 +05:30
if immediately_mergeable
2017-08-17 22:00:37 +05:30
::MergeRequests::MergeService
2021-06-08 01:23:25 +05:30
.new(project: merge_request.target_project, current_user: current_user, params: merge_params)
2017-08-17 22:00:37 +05:30
.execute(merge_request)
2020-03-13 15:44:24 +05:30
elsif automatically_mergeable
AutoMergeService.new(merge_request.target_project, current_user, merge_params)
.execute(merge_request, AutoMergeService::STRATEGY_MERGE_WHEN_PIPELINE_SUCCEEDS)
2016-04-02 18:10:28 +05:30
end
2014-09-02 18:07:02 +05:30
2022-08-27 11:52:29 +05:30
if immediately_mergeable && !merge_request.merged?
render_api_error!("Branch cannot be merged", 422)
else
present merge_request, with: Entities::MergeRequest, current_user: current_user, project: user_project
end
2017-08-17 22:00:37 +05:30
end
2019-09-30 21:07:59 +05:30
desc 'Returns the up to date merge-ref HEAD commit'
2021-04-29 21:17:54 +05:30
get ':id/merge_requests/:merge_request_iid/merge_ref', feature_category: :code_review do
2019-07-07 11:18:12 +05:30
merge_request = find_project_merge_request(params[:merge_request_iid])
2019-09-30 21:07:59 +05:30
result = ::MergeRequests::MergeabilityCheckService.new(merge_request).execute(recheck: true)
2019-07-07 11:18:12 +05:30
2019-09-30 21:07:59 +05:30
if result.success?
present :commit_id, result.payload.dig(:merge_ref_head, :commit_id)
2019-07-07 11:18:12 +05:30
else
2019-09-30 21:07:59 +05:30
render_api_error!(result.message, 400)
2019-07-07 11:18:12 +05:30
end
end
2017-08-17 22:00:37 +05:30
desc 'Cancel merge if "Merge When Pipeline Succeeds" is enabled' do
success Entities::MergeRequest
end
2021-04-29 21:17:54 +05:30
post ':id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds', feature_category: :code_review do
2017-08-17 22:00:37 +05:30
merge_request = find_project_merge_request(params[:merge_request_iid])
2019-09-04 21:01:54 +05:30
unauthorized! unless merge_request.can_cancel_auto_merge?(current_user)
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
AutoMergeService.new(merge_request.target_project, current_user).cancel(merge_request)
2017-08-17 22:00:37 +05:30
end
2019-02-15 15:39:39 +05:30
desc 'Rebase the merge request against its target branch' do
detail 'This feature was added in GitLab 11.6'
end
2020-03-13 15:44:24 +05:30
params do
optional :skip_ci, type: Boolean, desc: 'Do not create CI pipeline'
end
2022-01-26 12:08:38 +05:30
put ':id/merge_requests/:merge_request_iid/rebase', feature_category: :code_review, urgency: :low do
2019-02-15 15:39:39 +05:30
merge_request = find_project_merge_request(params[:merge_request_iid])
authorize_push_to_merge_request!(merge_request)
2020-03-13 15:44:24 +05:30
merge_request.rebase_async(current_user.id, skip_ci: params[:skip_ci])
2019-02-15 15:39:39 +05:30
status :accepted
2019-09-30 21:07:59 +05:30
present rebase_in_progress: merge_request.rebase_in_progress?
2019-12-26 22:10:19 +05:30
rescue ::MergeRequest::RebaseLockTimeout => e
render_api_error!(e.message, 409)
2019-02-15 15:39:39 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'List issues that will be closed on merge' do
success Entities::MRNote
end
params do
use :pagination
end
2022-01-26 12:08:38 +05:30
get ':id/merge_requests/:merge_request_iid/closes_issues', feature_category: :code_review, urgency: :low do
2017-08-17 22:00:37 +05:30
merge_request = find_merge_request_with_access(params[:merge_request_iid])
2018-11-18 11:00:15 +05:30
issues = ::Kaminari.paginate_array(merge_request.visible_closing_issues_for(current_user))
2017-09-10 17:25:29 +05:30
issues = paginate(issues)
external_issues, internal_issues = issues.partition { |issue| issue.is_a?(ExternalIssue) }
data = Entities::IssueBasic.represent(internal_issues, current_user: current_user)
data += Entities::ExternalIssue.represent(external_issues, current_user: current_user)
data.as_json
2014-09-02 18:07:02 +05:30
end
end
end
end