Class: Github::Repos::Merging

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/repos/merging.rb

Overview

The Repo Merging API supports merging branches in a repository. This accomplishes essentially the same thing as merging one branch into another in a local repository and then pushing to GitHub.

Constant Summary collapse

VALID_MERGE_PARAM_NAMES = 
%w[
  base
  head
  commit_message
].freeze
REQUIRED_MERGE_PARAMS =

:nodoc:

%w[ base head ].freeze

Constants included from Github::Request

Github::Request::METHODS, Github::Request::METHODS_WITH_BODIES

Constants included from Connection

Connection::ALLOWED_OPTIONS

Constants included from Constants

Constants::ACCEPT, Constants::ACCEPTED_OAUTH_SCOPES, Constants::ACCEPT_CHARSET, Constants::CACHE_CONTROL, Constants::CONTENT_LENGTH, Constants::CONTENT_TYPE, Constants::DATE, Constants::ETAG, Constants::HEADER_LAST, Constants::HEADER_LINK, Constants::HEADER_NEXT, Constants::LOCATION, Constants::META_FIRST, Constants::META_LAST, Constants::META_NEXT, Constants::META_PREV, Constants::META_REL, Constants::OAUTH_SCOPES, Constants::PARAM_PAGE, Constants::PARAM_PER_PAGE, Constants::PARAM_START_PAGE, Constants::RATELIMIT_LIMIT, Constants::RATELIMIT_REMAINING, Constants::SERVER, Constants::USER_AGENT

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Instance Attribute Summary

Attributes inherited from API

#current_options

Attributes included from Authorization

#scopes

Instance Method Summary collapse

Methods inherited from API

#api_methods_in, #append_arguments, #arguments, inherited, #initialize, #method_missing, #process_basic_auth, #set, #setup, #with, #yield_or_eval

Methods included from Github::RateLimit

#ratelimit, #ratelimit_remaining

Methods included from Github::Request

#delete_request, #get_request, #patch_request, #post_request, #put_request, #request

Methods included from Connection

#caching?, #clear_cache, #connection, #default_middleware, #default_options, #stack

Methods included from MimeType

#lookup_media, #parse

Methods included from Authorization

#auth_code, #authenticated?, #authentication, #authorize_url, #basic_authed?, #client, #get_token

Constructor Details

This class inherits a constructor from Github::API

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Github::API

Instance Method Details

#merge(*args) ⇒ Object

Perform a merge

Inputs

  • :base - Required String - The name of the base branch that the head will be merged into.

  • :head - Required String - The head to merge. This can be a branch name or a commit SHA1.

  • :commit_message - Optional String - Commit message to use for the merge commit. If omitted, a default message will be used.

Examples

github = Github.new
github.repos.merging.merge 'user', 'repo',
  "base": "master",
  "head": "cool_feature",
  "commit_message": "Shipped cool_feature!"



31
32
33
34
35
36
37
38
39
 
# File 'lib/github_api/repos/merging.rb', line 31

def merge(*args)
  arguments(args, :required => [:user, :repo]) do
    sift VALID_MERGE_PARAM_NAMES
    assert_required REQUIRED_MERGE_PARAMS
  end
  params = arguments.params

  post_request("/repos/#{user}/#{repo}/merges", params)
end