Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Updated options documentation for create MR and accept MR #573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NARKOZ merged 2 commits into from
Jul 6, 2020
Merged

Updated options documentation for create MR and accept MR #573

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3937ebb
Updating options documentation for accept MR
akashdotsrivastava Jul 6, 2020
7dc4740
Updating options documentation for create MR
akashdotsrivastava Jul 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion lib/gitlab/client/merge_requests.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,14 @@ def merge_request_participants(project, id)
# @option options [String] :source_branch (required) The source branch name.
# @option options [String] :target_branch (required) The target branch name.
# @option options [Integer] :assignee_id (optional) The ID of a user to assign merge request.
# @option options [Array<Integer>] :assignee_ids (optional) The ID of the user(s) to assign the MR to. Set to 0 or provide an empty value to unassign all assignees.
# @option options [String] :description (optional) Description of MR. Limited to 1,048,576 characters.
# @option options [Integer] :target_project_id (optional) The target project ID.
# @option options [String] :labels (optional) Labels as a comma-separated list.
# @option options [Integer] :milestone_id (optional) The global ID of a milestone
# @option options [Boolean] :remove_source_branch (optional) Flag indicating if a merge request should remove the source branch when merging
# @option options [Boolean] :allow_collaboration (optional) Allow commits from members who can merge to the target branch
# @option options [Boolean] :squash (optional) Squash commits into a single commit when merging
# @return [Gitlab::ObjectifiedHash] Information about created merge request.
def create_merge_request(project, title, options = {})
body = { title: title }.merge(options)
Expand Down Expand Up @@ -119,7 +125,12 @@ def update_merge_request(project, id, options = {})
# @param [Integer, String] project The ID or name of a project.
# @param [Integer] id The ID of a merge request.
# @param [Hash] options A customizable set of options.
# @option options [String] :merge_commit_message Custom merge commit message
# @option options [String] :merge_commit_message(optional) Custom merge commit message
# @option options [String] :squash_commit_message(optional) Custom squash commit message
# @option options [Boolean] :squash(optional) if true the commits will be squashed into a single commit on merge
# @option options [Boolean] :should_remove_source_branch(optional) if true removes the source branch
# @option options [Boolean] :merge_when_pipeline_succeeds(optional) if true the MR is merged when the pipeline succeeds
# @option options [String] :sha(optional) if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail
# @return [Gitlab::ObjectifiedHash] Information about updated merge request.
def accept_merge_request(project, id, options = {})
put("/projects/#{url_encode project}/merge_requests/#{id}/merge", body: options)
Expand Down