module Github::GitData::References
def create_reference(user_name, repo_name, params={})
"sha" => "827efc6d56897b048c772eb4087f854f46256132"
"ref" => "refs/heads/master",
@github.git_data.create_reference 'user-name', 'repo-name',
@github = Github.new
= Examples
* :sha - String of the SHA1 value to set this reference to
* :ref - String of the name of the fully qualified reference (ie: refs/heads/master). If it doesn’t start with ‘refs’ and have at least two slashes, it will be rejected.
= Inputs
Create a reference
def create_reference(user_name, repo_name, params={}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _normalize_params_keys(params) raise ArgumentError, "Required params are: ref, sha" unless _validate_inputs(%w[ ref sha ], params) _filter_params_keys(VALID_REF_PARAM_NAMES, params) _validate_params_values(VALID_REF_PARAM_VALUES, params) post("/repos/#{user}/#{repo}/git/refs", params) end
def reference(user_name, repo_name, ref, params={})
@github.git_data.reference 'user-name', 'repo-name', 'reference'
@github = Github.new
= Examples
heads/sc/featureA
branch named sc/featureA would be formatted as
not just branch. For example, the call to get the data for a
The ref in the URL must be formatted as heads/branch,
Get a reference
def reference(user_name, repo_name, ref, params={}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _validate_presence_of ref _normalize_params_keys(params) get("/repos/#{user}/#{repo}/git/refs/#{ref}", params) end
def references(user_name, repo_name, ref=nil, params={})
@github.git_data.references 'user-name', 'repo-name', 'tags'
@github.git_data.references 'user-name', 'repo-name'
@github = Github.new
= Examples
though that would be the most common.
Anything in the namespace, not just heads and tags,
including things like notes and stashes if they exist on the server.
This will return an array of all the references on the system,
Get all references
def references(user_name, repo_name, ref=nil, params={}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _normalize_params_keys(params) response = if ref get("/repos/#{user}/#{repo}/git/refs/#{ref}") else get("/repos/#{user}/#{repo}/git/refs") end return response unless block_given? response.each { |el| yield el } end
def update_reference(user_name, repo_name, ref, params={})
"force" => true
"sha" => "827efc6d56897b048c772eb4087f854f46256132",
@github.git_data.create_reference 'user-name', 'repo-name',
@github = Github.new
= Examples
* :force - Boolean indicating whether to force the update or to make sure the update is a fast-forward update. The default is false, so leaving this out or setting it to false will make sure you’re not overwriting work.
* :sha - String of the SHA1 value to set this reference to
= Inputs
Update a reference
def update_reference(user_name, repo_name, ref, params={}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _validate_presence_of ref _normalize_params_keys(params) raise ArgumentError, "Required params are: sha" unless _validate_inputs(%w[ sha ], params) _filter_params_keys(VALID_REF_PARAM_NAMES, params) _validate_params_values(VALID_REF_PARAM_VALUES, params) patch("/repos/#{user}/#{repo}/git/refs/#{ref}", params) end