Module: Gitlab::Client::MergeRequests

Included in:
Gitlab::Client
Defined in:
lib/gitlab/client/merge_requests.rb

Overview

Defines methods related to merge requests.

Instance Method Summary collapse

Instance Method Details

#accept_merge_request(project, id, options = {}) ⇒ Gitlab::ObjectifiedHash

Accepts a merge request.

Examples:

Gitlab.accept_merge_request(5, 42, { merge_commit_message: 'Nice!' })

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

  • options (Hash) (defaults to: {})

    A customizable set of options.

Options Hash (options):

  • :merge_commit_message(optional) (String)

    Custom merge commit message

  • :squash_commit_message(optional) (String)

    Custom squash commit message

  • :squash(optional) (Boolean)

    if true the commits will be squashed into a single commit on merge

  • :should_remove_source_branch(optional) (Boolean)

    if true removes the source branch

  • :merge_when_pipeline_succeeds(optional) (Boolean)

    if true the MR is merged when the pipeline succeeds

  • :sha(optional) (String)

    if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail

Returns:


135
136
137
# File 'lib/gitlab/client/merge_requests.rb', line 135

def accept_merge_request(project, id, options = {})
  put("/projects/#{url_encode project}/merge_requests/#{id}/merge", body: options)
end

#create_merge_request(project, title, options = {}) ⇒ Gitlab::ObjectifiedHash

Creates a merge request.

Examples:

Gitlab.create_merge_request(5, 'New merge request',
  { source_branch: 'source_branch', target_branch: 'target_branch' })
Gitlab.create_merge_request(5, 'New merge request',
  { source_branch: 'source_branch', target_branch: 'target_branch', assignee_id: 42 })

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • title (String)

    The title of a merge request.

  • options (Hash) (defaults to: {})

    A customizable set of options.

Options Hash (options):

  • :source_branch (String) — default: required

    The source branch name.

  • :target_branch (String) — default: required

    The target branch name.

  • :assignee_id (Integer) — default: optional

    The ID of a user to assign merge request.

  • :assignee_ids (Array<Integer>) — default: optional

    The ID of the user(s) to assign the MR to. Set to 0 or provide an empty value to unassign all assignees.

  • :description (String) — default: optional

    Description of MR. Limited to 1,048,576 characters.

  • :target_project_id (Integer) — default: optional

    The target project ID.

  • :labels (String) — default: optional

    Labels as a comma-separated list.

  • :milestone_id (Integer) — default: optional

    The global ID of a milestone

  • :remove_source_branch (Boolean) — default: optional

    Flag indicating if a merge request should remove the source branch when merging

  • :allow_collaboration (Boolean) — default: optional

    Allow commits from members who can merge to the target branch

  • :squash (Boolean) — default: optional

    Squash commits into a single commit when merging

Returns:


97
98
99
100
# File 'lib/gitlab/client/merge_requests.rb', line 97

def create_merge_request(project, title, options = {})
  body = { title: title }.merge(options)
  post("/projects/#{url_encode project}/merge_requests", body: body)
end

#create_merge_request_discussion(project, merge_request_id, options = {}) ⇒ Gitlab::ObjectifiedHash

Create new merge request discussion

Examples:

Gitlab.create_merge_request_discussion(5, 1, body: 'discuss')
Gitlab.create_merge_request_discussion('gitlab', 1, body: 'discuss')

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

  • options (Hash) (defaults to: {})

    A customizable set of options.

    • :body (String) The content of a discussion

    • :created_at (String) Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z

    • :position (Hash) Position when creating a diff note

      • :base_sha (String) Base commit SHA in the source branch

      • :start_sha (String) SHA referencing commit in target branch

      • :head_sha (String) SHA referencing HEAD of this merge request

      • :position_type (String) Type of the position reference', allowed values: 'text' or 'image'

      • :new_path (String) File path after change

      • :new_line (Integer) Line number after change (for 'text' diff notes)

      • :old_path (String) File path before change

      • :old_line (Integer) Line number before change (for 'text' diff notes)

      • :width (Integer) Width of the image (for 'image' diff notes)

      • :height (Integer) Height of the image (for 'image' diff notes)

      • :x (Integer) X coordinate (for 'image' diff notes)

      • :y (Integer) Y coordinate (for 'image' diff notes)

Returns:


249
250
251
# File 'lib/gitlab/client/merge_requests.rb', line 249

def create_merge_request_discussion(project, merge_request_id, options = {})
  post("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions", body: options)
end

#create_merge_request_discussion_note(project, merge_request_id, discussion_id, options) ⇒ Gitlab::ObjectifiedHash

Add note to existing merge request discussion

Examples:

Gitlab.create_merge_request_discussion_note(5, 1, 1, note_id: 1, body: 'note')
Gitlab.create_merge_request_discussion_note('gitlab', 1, 1, note_id: 1, body: 'note')

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

  • discussion_id (Integer)

    The ID of a discussion.

  • options (Hash)

    A customizable set of options.

Options Hash (options):

  • :note_id (Integer)

    The ID of a discussion note.

  • :body (String)

    The content of a discussion.

  • :created_at (String)

    Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z.

Returns:


281
282
283
# File 'lib/gitlab/client/merge_requests.rb', line 281

def create_merge_request_discussion_note(project, merge_request_id, discussion_id, options)
  post("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions/#{discussion_id}/notes", body: options)
end

#delete_merge_request_discussion_note(project, merge_request_id, discussion_id, note_id) ⇒ Gitlab::ObjectifiedHash

Delete a merge request discussion note

Examples:

Gitlab.delete_merge_request_discussion_note(5, 1, 1, 1)
Gitlab.delete_merge_request_discussion_note('gitlab', 1, 1, 1)

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

  • discussion_id (Integer)

    The ID of a discussion.

  • note_id (Integer)

    The ID of a discussion note.

Returns:


312
313
314
# File 'lib/gitlab/client/merge_requests.rb', line 312

def delete_merge_request_discussion_note(project, merge_request_id, discussion_id, note_id)
  delete("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions/#{discussion_id}/notes/#{note_id}")
end

#merge_request(project, id, options = {}) ⇒ Gitlab::ObjectifiedHash

Gets a single merge request.

Examples:

Gitlab.merge_request(5, 36)
Gitlab.merge_request(5, 36, { include_diverged_commits_count: true })

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :render_html (Boolean)

    If true response includes rendered HTML for title and description.

  • :include_diverged_commits_count (Boolean)

    If true response includes the commits behind the target branch.

  • :include_rebase_in_progress (Boolean)

    If true response includes whether a rebase operation is in progress.

Returns:


46
47
48
# File 'lib/gitlab/client/merge_requests.rb', line 46

def merge_request(project, id, options = {})
  get("/projects/#{url_encode project}/merge_requests/#{id}", query: options)
end

#merge_request_changes(project, id) ⇒ Gitlab::ObjectifiedHash

Gets the changes of a merge request.

Examples:

Gitlab.merge_request_changes(5, 1)

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

Returns:


147
148
149
# File 'lib/gitlab/client/merge_requests.rb', line 147

def merge_request_changes(project, id)
  get("/projects/#{url_encode project}/merge_requests/#{id}/changes")
end

#merge_request_closes_issues(project_id, merge_request_iid) ⇒ Object

List issues that will close on merge

Examples:

Gitlab.merge_request_closes_issues(5, 1)

Parameters:

  • project (Integer)

    The ID of a project

  • iid (Integer)

    The internal ID of a merge request


170
171
172
# File 'lib/gitlab/client/merge_requests.rb', line 170

def merge_request_closes_issues(project_id, merge_request_iid)
  get("/projects/#{project_id}/merge_requests/#{merge_request_iid}/closes_issues")
end

#merge_request_commits(project, id) ⇒ Array<Gitlab::ObjectifiedHash>

Gets the commits of a merge request.

Examples:

Gitlab.merge_request_commits(5, 1)

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

Returns:


159
160
161
# File 'lib/gitlab/client/merge_requests.rb', line 159

def merge_request_commits(project, id)
  get("/projects/#{url_encode project}/merge_requests/#{id}/commits")
end

#merge_request_diff_version(project, merge_request_id, version_id) ⇒ Gitlab::ObjectifiedHash

Gets the diff a single merge request diff version\

Examples:

Gitlab.merge_request_diff_version(5, 1, 1)
Gitlab.merge_request_diff_version('gitlab', 1, 1)

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

  • id (Integer)

    The ID of a merge request diff version.

Returns:


337
338
339
# File 'lib/gitlab/client/merge_requests.rb', line 337

def merge_request_diff_version(project, merge_request_id, version_id)
  get("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/versions/#{version_id}")
end

#merge_request_diff_versions(project, merge_request_id) ⇒ Gitlab::ObjectifiedHash

Gets a list of merge request diff versions

Examples:

Gitlab.merge_request_versions(5, 1)
Gitlab.merge_request_versions('gitlab', 1)

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

Returns:


324
325
326
# File 'lib/gitlab/client/merge_requests.rb', line 324

def merge_request_diff_versions(project, merge_request_id)
  get("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/versions")
end

#merge_request_discussion(project, merge_request_id, discussion_id) ⇒ Gitlab::ObjectifiedHash

Get single merge request discussion

Examples:

Gitlab.merge_request_discussion(5, 1, 1)
Gitlab.merge_request_discussion('gitlab', 1, 1)

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

  • discussion_id (Integer)

    The ID of a discussion.

Returns:


221
222
223
# File 'lib/gitlab/client/merge_requests.rb', line 221

def merge_request_discussion(project, merge_request_id, discussion_id)
  get("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions/#{discussion_id}")
end

#merge_request_discussions(project, merge_request_id) ⇒ Gitlab::ObjectifiedHash

List project merge request discussions

Examples:

Gitlab.merge_request_discussions(5, 1)
Gitlab.merge_request_discussions('gitlab', 1)

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

Returns:


208
209
210
# File 'lib/gitlab/client/merge_requests.rb', line 208

def merge_request_discussions(project, merge_request_id)
  get("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions")
end

#merge_request_participants(project, id) ⇒ Array<Gitlab::ObjectifiedHash>

Get a list of merge request participants.

Examples:

Gitlab.merge_request_participants(5, 36)

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

Returns:


70
71
72
# File 'lib/gitlab/client/merge_requests.rb', line 70

def merge_request_participants(project, id)
  get("/projects/#{url_encode project}/merge_requests/#{id}/participants")
end

#merge_request_pipelines(project, id) ⇒ Array<Gitlab::ObjectifiedHash>

Gets a list of merge request pipelines.

Examples:

Gitlab.merge_request_pipelines(5, 36)

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

Returns:


58
59
60
# File 'lib/gitlab/client/merge_requests.rb', line 58

def merge_request_pipelines(project, id)
  get("/projects/#{url_encode project}/merge_requests/#{id}/pipelines")
end

#merge_requests(project, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

Gets a list of project merge requests.

Examples:

Gitlab.merge_requests(5)
Gitlab.merge_requests(5, { per_page: 40 })

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • options (Hash) (defaults to: {})

    A customizable set of options.

Options Hash (options):

  • :page (Integer)

    The page number.

  • :per_page (Integer)

    The number of results per page.

Returns:


30
31
32
# File 'lib/gitlab/client/merge_requests.rb', line 30

def merge_requests(project, options = {})
  get("/projects/#{url_encode project}/merge_requests", query: options)
end

#resolve_merge_request_discussion(project, merge_request_id, discussion_id, options) ⇒ Gitlab::ObjectifiedHash

Resolve a merge request discussion

Examples:

Gitlab.resolve_merge_request_discussion(5, 1, 1, true)
Gitlab.resolve_merge_request_discussion('gitlab', 1, 1, false)

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

  • discussion_id (Integer)

    The ID of a discussion.

  • options (Hash)

    A customizable set of options.

Options Hash (options):

  • :resolved (Boolean)

    Resolve/unresolve the discussion.

Returns:


264
265
266
# File 'lib/gitlab/client/merge_requests.rb', line 264

def resolve_merge_request_discussion(project, merge_request_id, discussion_id, options)
  put("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions/#{discussion_id}", body: options)
end

#subscribe_to_merge_request(project, id) ⇒ Gitlab::ObjectifiedHash

Subscribes to a merge request.

Examples:

Gitlab.subscribe_to_merge_request(5, 1)
Gitlab.subscribe_to_merge_request('gitlab', 1)

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

Returns:


183
184
185
# File 'lib/gitlab/client/merge_requests.rb', line 183

def subscribe_to_merge_request(project, id)
  post("/projects/#{url_encode project}/merge_requests/#{id}/subscribe")
end

#unsubscribe_from_merge_request(project, id) ⇒ Gitlab::ObjectifiedHash

Unsubscribes from a merge request.

Examples:

Gitlab.unsubscribe_from_merge_request(5, 1)
Gitlab.unsubscribe_from_merge_request('gitlab', 1)

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

Returns:


196
197
198
# File 'lib/gitlab/client/merge_requests.rb', line 196

def unsubscribe_from_merge_request(project, id)
  post("/projects/#{url_encode project}/merge_requests/#{id}/unsubscribe")
end

#update_merge_request(project, id, options = {}) ⇒ Gitlab::ObjectifiedHash

Updates a merge request.

Examples:

Gitlab.update_merge_request(5, 42, { title: 'New title' })

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

  • options (Hash) (defaults to: {})

    A customizable set of options.

Options Hash (options):

  • :title (String)

    The title of a merge request.

  • :source_branch (String)

    The source branch name.

  • :target_branch (String)

    The target branch name.

  • :assignee_id (Integer)

    The ID of a user to assign merge request.

  • :state_event (String)

    New state (close|reopen|merge).

Returns:


116
117
118
# File 'lib/gitlab/client/merge_requests.rb', line 116

def update_merge_request(project, id, options = {})
  put("/projects/#{url_encode project}/merge_requests/#{id}", body: options)
end

#update_merge_request_discussion_note(project, merge_request_id, discussion_id, note_id, options) ⇒ Gitlab::ObjectifiedHash

Modify an existing merge request discussion note

Examples:

Gitlab.update_merge_request_discussion_note(5, 1, 1, 1, body: 'note')
Gitlab.update_merge_request_discussion_note('gitlab', 1, 1, 1, body: 'note')

Parameters:

  • project (Integer, String)

    The ID or name of a project.

  • id (Integer)

    The ID of a merge request.

  • discussion_id (Integer)

    The ID of a discussion.

  • note_id (Integer)

    The ID of a discussion note.

  • options (Hash)

    A customizable set of options.

Options Hash (options):

  • :body (String)

    The content of a discussion.

  • :resolved (Boolean)

    Resolve/unresolve the note.

Returns:


298
299
300
# File 'lib/gitlab/client/merge_requests.rb', line 298

def update_merge_request_discussion_note(project, merge_request_id, discussion_id, note_id, options)
  put("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions/#{discussion_id}/notes/#{note_id}", body: options)
end

#user_merge_requests(options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

Gets a list of all of the merge requests the authenticated user has access to.

Examples:

Gitlab.user_merge_requests
Gitlab.user_merge_requests(state: :opened, scope: :all)

Parameters:

  • options (Hash) (defaults to: {})

    A customizable set of options.

Returns:


15
16
17
# File 'lib/gitlab/client/merge_requests.rb', line 15

def user_merge_requests(options = {})
  get('/merge_requests', query: options)
end