Sha256: 90b21224f842b92ff89f01e6b5251e5dd8a2df2e98246581614f36f8b7fafdbc
Contents?: true
Size: 1.32 KB
Versions: 14
Compression:
Stored size: 1.32 KB
Contents
# encoding: utf-8
module Github
# 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.
class Repos::Merging < API
VALID_MERGE_PARAM_NAMES = %w[
base
head
commit_message
].freeze # :nodoc:
REQUIRED_MERGE_PARAMS = %w[ base head ].freeze # :nodoc:
# Perform a merge
#
# = Inputs
# * <tt>:base</tt> - Required String - The name of the base branch that the head will be merged into.
# * <tt>:head</tt> - Required String - The head to merge. This can be a branch name or a commit SHA1.
# * <tt>:commit_message</tt> - 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!"
#
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
end # Repos::Merging
end # Github
Version data entries
14 entries across 14 versions & 1 rubygems