Module: Octokit::Client::Checks

Get a single check run

# File 'lib/octokit/client/checks.rb', line 100

def check_run(repo, id, options = {})
 get "#{Repository.path repo}/check-runs/#{id}", options
end

List annotations for a check run

Examples:

annotations = @client.check_run_annotations("octocat/Hello-World", 51295429)
annotations.count # => 1
annotations[0].path # => "README.md"
annotations[0].message # => "Looks good!"

# File 'lib/octokit/client/checks.rb', line 115

def check_run_annotations(repo, id, options = {})
 paginate "#{Repository.path repo}/check-runs/#{id}/annotations", options
end

List check runs in a check suite

Examples:

result = @client.check_runs_for_check_suite("octocat/Hello-World", 50440400, status: "in_progress")
result.total_count # => 1
result.check_runs.count # => 1
result.check_runs[0].check_suite.id # => 50440400
result.check_runs[0].status # => "in_progress"

# File 'lib/octokit/client/checks.rb', line 86

def check_runs_for_check_suite(repo, id, options = {})
 paginate "#{Repository.path repo}/check-suites/#{id}/check-runs", options do |data, last_response|
 data.check_runs.concat last_response.data.check_runs
 data.total_count += last_response.data.total_count
 end
end

List check runs for a specific ref

Examples:

result = @client.check_runs_for_ref("octocat/Hello-World", "7638417db6d59f3c431d3e1f261cc637155684cd", status: "in_progress")
result.total_count # => 1
result.check_runs.count # => 1
result.check_runs[0].id # => 51295429
result.check_runs[0].status # => "in_progress"

# File 'lib/octokit/client/checks.rb', line 62

def check_runs_for_ref(repo, ref, options = {})
 paginate "#{Repository.path repo}/commits/#{ref}/check-runs", options do |data, last_response|
 data.check_runs.concat last_response.data.check_runs
 data.total_count += last_response.data.total_count
 end
end

Get a single check suite

# File 'lib/octokit/client/checks.rb', line 129

def check_suite(repo, id, options = {})
 get "#{Repository.path repo}/check-suites/#{id}", options
end

List check suites for a specific ref

Examples:

result = @client.check_suites_for_ref("octocat/Hello-World", "7638417db6d59f3c431d3e1f261cc637155684cd", app_id: 76765)
result.total_count # => 1
result.check_suites.count # => 1
result.check_suites[0].id # => 50440400
result.check_suites[0].app.id # => 76765

# File 'lib/octokit/client/checks.rb', line 148

def check_suites_for_ref(repo, ref, options = {})
 paginate "#{Repository.path repo}/commits/#{ref}/check-suites", options do |data, last_response|
 data.check_suites.concat last_response.data.check_suites
 data.total_count += last_response.data.total_count
 end
end

Create a check run

Examples:

check_run = @client.create_check_run("octocat/Hello-World", "my-check", "7638417db6d59f3c431d3e1f261cc637155684cd")
check_run.name # => "my-check"
check_run.head_sha # => "7638417db6d59f3c431d3e1f261cc637155684cd"
check_run.status # => "queued"

# File 'lib/octokit/client/checks.rb', line 25

def create_check_run(repo, name, head_sha, options = {})
 options[:name] = name
 options[:head_sha] = head_sha

 post "#{Repository.path repo}/check-runs", options
end

Create a check suite

Examples:

check_suite = @client.create_check_suite("octocat/Hello-World", "7638417db6d59f3c431d3e1f261cc637155684cd")
check_suite.head_sha # => "7638417db6d59f3c431d3e1f261cc637155684cd"
check_suite.status # => "queued"

# File 'lib/octokit/client/checks.rb', line 182

def create_check_suite(repo, head_sha, options = {})
 options[:head_sha] = head_sha

 post "#{Repository.path repo}/check-suites", options
end

Alias for #check_runs_for_check_suite.

# File 'lib/octokit/client/checks.rb', line 92

alias list_check_runs_for_check_suite check_runs_for_check_suite

Alias for #check_runs_for_ref.

# File 'lib/octokit/client/checks.rb', line 68

alias list_check_runs_for_ref check_runs_for_ref

Alias for #check_suites_for_ref.

# File 'lib/octokit/client/checks.rb', line 154

alias list_check_suites_for_ref check_suites_for_ref

Rerequest check suite

# File 'lib/octokit/client/checks.rb', line 194

def rerequest_check_suite(repo, id, options = {})
 post "#{Repository.path repo}/check-suites/#{id}/rerequest", options
 true
end

Set preferences for check suites on a repository

Examples:

result = @client.set_check_suite_preferences("octocat/Hello-World", auto_trigger_checks: [{ app_id: 76765, setting: false }])
result.preferences.auto_trigger_checks.count # => 1
result.preferences.auto_trigger_checks[0].app_id # => 76765
result.preferences.auto_trigger_checks[0].setting # => false
result.repository.full_name # => "octocat/Hello-World"

# File 'lib/octokit/client/checks.rb', line 168

def set_check_suite_preferences(repo, options = {})
 patch "#{Repository.path repo}/check-suites/preferences", options
end

Update a check run

Examples:

check_run = @client.update_check_run("octocat/Hello-World", 51295429, status: "in_progress")
check_run.id # => 51295429
check_run.status # => "in_progress"

# File 'lib/octokit/client/checks.rb', line 42

def update_check_run(repo, id, options = {})
 patch "#{Repository.path repo}/check-runs/#{id}", options
end