checks.md

Repo / Checks API

Back to the "Repos API" | Back to the navigation

Create a check for a commit

Visit GitHub for a full of list of parameters and their descriptions.

$params = [
  'name' => 'my check', # required
  'head_sha' => $commitSha, # required
  'status' => 'pending',
  'details_url' => 'https://nimbleci.com/...',
  'output' => {...}
];
$checks = $client->api('repo')->checks()->create('NimbleCI', 'docker-web-tester-behat', $params);

Update an existing check on a commit

https://developer.github.com/v3/checks/runs/#update-a-check-run

$params = [
  'name' => 'my check',
  'status' => 'pending',
  'details_url' => 'https://nimbleci.com/...',
  'output' => {...}
];
$checks = $client->api('repo')->checks()->create('NimbleCI', 'docker-web-tester-behat', $checkRunId, $params);