Module: Octokit::Client::Statuses

Included in:
Octokit::Client
Defined in:
lib/octokit/client/statuses.rb

Overview

Methods for the Commit Statuses API

See Also:

Constant Summary collapse

COMBINED_STATUS_MEDIA_TYPE = 
"application/vnd.github.she-hulk-preview+json"

Instance Method Summary collapse

Instance Method Details

#combined_status(repo, ref, options = {}) ⇒ Sawyer::Resource Also known as: status

Get the combined status for a ref

Parameters:

  • repo (String, Repository, Hash) —

    a GitHub repository

  • ref (String) —

    A Sha or Ref to fetch the status of

Returns:

  • (Sawyer::Resource) —

    The combined status for the commit

See Also:



27
28
29
30
 
# File 'lib/octokit/client/statuses.rb', line 27

def combined_status(repo, ref, options = {})
  ensure_combined_status_api_media_type(options)
  get "repos/#{Repository.new(repo)}/commits/#{ref}/status", options
end

#create_status(repo, sha, state, options = {}) ⇒ Sawyer::Resource

Create status for a commit

Parameters:

  • repo (String, Repository, Hash) —

    A GitHub repository

  • sha (String) —

    The SHA1 for the commit

  • state (String) —

    The state: pending, success, failure, error

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :context (String) —

    A context to differentiate this status from others

  • :target_url (String) —

    A link to more details about this status

  • :description (String) —

    A short human-readable description of this status

Returns:

  • (Sawyer::Resource) —

    A status

See Also:



43
44
45
46
 
# File 'lib/octokit/client/statuses.rb', line 43

def create_status(repo, sha, state, options = {})
  options.merge!(:state => state)
  post "repos/#{Repository.new(repo)}/statuses/#{sha}", options
end

#statuses(repo, sha, options = {}) ⇒ Array<Sawyer::Resource> Also known as: list_statuses

List all statuses for a given commit

Parameters:

  • repo (String, Repository, Hash) —

    A GitHub repository

  • sha (String) —

    The SHA1 for the commit

Returns:

  • (Array<Sawyer::Resource>) —

    A list of statuses

See Also:



16
17
18
 
# File 'lib/octokit/client/statuses.rb', line 16

def statuses(repo, sha, options = {})
  get "repos/#{Repository.new(repo)}/statuses/#{sha}", options
end