Create a reference
@param [Hash] params @input params [String] :ref
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.
@input params [String] :sha
The SHA1 value to set this reference to
@example
github = Github.new github.git_data.references.create 'user-name', 'repo-name', ref: "refs/heads/master", sha: "827efc6d56897b048c772eb4087f854f46256132"
@api public
# File lib/github_api/client/git_data/references.rb, line 82 def create(*args) arguments(args, required: [:user, :repo]) do permit VALID_REF_PARAM_NAMES assert_required REQUIRED_REF_PARAMS end params = arguments.params validate_reference params['ref'] post_request("/repos/#{arguments.user}/#{arguments.repo}/git/refs", params) end
Delete a reference
@example
github = Github.new github.git_data.references.delete 'user-name', 'repo-name', ref: "refs/heads/master"
@api public
# File lib/github_api/client/git_data/references.rb, line 127 def delete(*args) arguments(args, required: [:user, :repo, :ref]) params = arguments.params delete_request("/repos/#{arguments.user}/#{arguments.repo}/git/refs/#{arguments.ref}", params) end
Get a reference
The ref in the URL must be formatted as heads/branch, not just branch. For example, the call to get the data for a branch named sc/featureA would be formatted as heads/sc/featureA
@example
github = Github.new github.git_data.references.get 'user-name', 'repo-name', 'heads/branch'
@api public
# File lib/github_api/client/git_data/references.rb, line 56 def get(*args) arguments(args, required: [:user, :repo, :ref]) validate_reference arguments.ref params = arguments.params get_request("/repos/#{arguments.user}/#{arguments.repo}/git/refs/#{arguments.ref}", params) end
Get all references
This will return an array of all the references on the system, including things like notes and stashes if they exist on the server. Anything in the namespace, not just heads and tags, though that would be the most common.
@example
github = Github.new github.git_data.references.list 'user-name', 'repo-name'
@example
github.git_data.references.list 'user-name', 'repo-name', ref:'tags'
@api public
# File lib/github_api/client/git_data/references.rb, line 28 def list(*args) arguments(args, required: [:user, :repo]) params = arguments.params user = arguments.user repo = arguments.repo response = if (ref = params.delete('ref')) validate_reference ref get_request("/repos/#{user}/#{repo}/git/refs/#{ref}", params) else get_request("/repos/#{user}/#{repo}/git/refs", params) end return response unless block_given? response.each { |el| yield el } end
Update a reference
@param [Hash] params @input params [String] :sha
The SHA1 value to set this reference to
@input params [Boolean] :force
Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you’re not overwriting work. Default: false
@example
github = Github.new github.git_data.references.update 'user-name', 'repo-name', 'heads/master', sha: "827efc6d56897b048c772eb4087f854f46256132", force: true
@api public
# File lib/github_api/client/git_data/references.rb, line 110 def update(*args) arguments(args, required: [:user, :repo, :ref]) do permit VALID_REF_PARAM_NAMES assert_required ] sha ] end patch_request("/repos/#{arguments.user}/#{arguments.repo}/git/refs/#{arguments.ref}", arguments.params) end
Generated with the Darkfish Rdoc Generator 2.