Skip to main content

REST API を使用してチェックを操作する

REST API を使って、リポジトリでのコード変更に対して強力なチェックを行う GitHub Apps を構築できます。 継続的インテグレーション、コードの構文チェック、コードのスキャンサービスを実行し、コミットについて詳細なフィードバックを行うアプリを作成できます。

概要

GitHub Apps は、合格と不合格の 2 つのビルド状態ではなく、情報量の多い状態を報告し、詳細な情報でコード行に注釈を付け、テストを再実行することができます。 チェックを管理するための REST API は、GitHub Apps でのみ使用できます。

REST API を GitHub App で使う方法の例については、「Checks API で CI テストを作成する」をご覧ください。

チェックスイートについて

誰かがリポジトリにコードをプッシュすると、その直近のコミットについてGitHubはチェックスイートを作成します。 チェック スイートは、特定のコミットに対して単一の GitHub App によって作成されたチェック実行のコレクションです。 チェックスイートは、スイートに含まれるチェックを実行し、ステータスとチェック結果をまとめます。

チェックスイートのワークフロー

チェック スイートは、チェック スイートの conclusion の中で最も優先度の高いチェック実行 conclusion を報告します。 たとえば、3 回のチェック実行で timed_outsuccessneutral の結論が得られた場合、チェック スイートの結論は timed_out になります。

デフォルトでは、GitHubはリポジトリにコードがプッシュされると自動的にチェックスイートを作成します。 この既定のフローでは、checks:write のアクセス許可をもつすべての GitHub アプリに check_suite イベント (requested アクションあり) が送信されます。 GitHub App が check_suite イベントを受信すると、直近のコミットに対する新たなチェック実行を作成できます。 GitHub では、チェック実行のリポジトリと SHA に基づいて、正しいチェック スイートに新しいチェック実行が自動的に追加されます。

デフォルトの自動的なフローを使いたくない場合は、チェックスイートをいつ作成するかをコントロールできます。 チェック スイートの作成に関する既定の設定を変更するには、チェックスイートのリポジトリ環境設定の更新エンドポイントを使用します。 自動フロー設定に対するすべての変更は、リポジトリのAudit logに記録されます。 自動フローを無効にした場合は、チェック スイートの作成エンドポイントを使用してチェック スイートを作成できます。 コミットに関するフィードバックを提供するには、引き続きチェック実行の作成エンドポイントを使用する必要があります。

チェックを操作する REST API の書き込み許可は、GitHub Apps に対してのみ使用できます。 OAuth Apps および認証済みユーザーは、チェック実行とチェック スイートを表示することができますが、作成することはできません。 GitHub App を構築していない場合、この REST API を使ってコミット状態を操作することもできます。

エンドポイントを使ってチェック スイートを管理するには、GitHub App に checks:write アクセス許可が必要であり、check_suite Webhook をサブスクライブすることもできます。

GitHub アプリとして認証する方法については、GitHub アプリの認証オプションに関する記事を参照してください。

チェックの実行について

チェックの実行は、個別のテストであり、チェックスイートの一機能です。 各実行にステータスと結果が含まれます。

チェック実行のワークフロー

チェック実行が 14 日を超えて不完全な状態である場合は、チェック実行の conclusionstale になり、GitHub に stale として と共に表示されます。 チェック実行を stale としてマークできるのは GitHub のみです。 チェック実行で出る可能性のある結論の詳細については、conclusion パラメーターを参照してください。

check_suite Webhook を受け取るとすぐに、チェックが完了していない場合でも、チェック実行を作成できます。 チェック実行が値 queuedin_progress、または completed で完了したら、チェック実行の status を更新できます。さらに詳細が入手できるにつれ output を更新できます。 チェック実行にはタイムスタンプ、詳細情報が記載された外部サイトへのリンク、コードの特定の行に対するアノテーション、および実行した分析についての情報を含めることができます。

チェック実行のアノテーション

チェック実行は、GitHub UIで手動で再実行することも可能です。 詳細については、「ステータス チェックについて」を参照してください。 この場合、チェック実行を作成した GitHub App は、新しいチェック実行を要求する check_run webhook を受け取ります。 チェックスイートを作成せずにチェック実行を作成した場合、GitHubは自動的にチェックスイートを作成します。

チェックを操作する REST API の書き込み許可は、GitHub Apps に対してのみ使用できます。 OAuth Apps および認証済みユーザーは、チェック実行とチェック スイートを表示することができますが、作成することはできません。 GitHub App を構築していない場合、この REST API を使ってコミット状態を操作することもできます。

エンドポイントを使ってチェックの実行を管理するには、GitHub App に checks:write アクセス許可が必要であり、check_run Webhook をサブスクライブすることもできます。

チェック実行とリクエストされたアクション

チェック実行をリクエストされたアクション (GitHub Actionsと混同しないこと) で設定すると、 GitHubのプルリクエストビューでボタンを表示でき、そのボタンでGitHub Appに追加のタスクを実行するようリクエストできるます。

たとえば、コードの構文チェックを行うアプリケーションは、リクエストされたアクションを使って、検出した構文エラーを自動的に修正するボタンをプルリクエストに表示できます。

アプリから追加のアクションを要求できるボタンを作成するには、チェック ランの作成を行うときに actions オブジェクトを使用します。 たとえば、以下の actions オブジェクトは、プル要求に「Fix this」というラベルのついたボタンを表示します。 このボタンは、チェック実行が完了した後に表示されます。

"actions": [{
   "label": "Fix this",
   "description": "Let us fix that for you",
   "identifier": "fix_errors"
 }]

チェック実行のリクエストされたアクションのボタン

ユーザーがボタンをクリックすると、GitHub は check_run.requested_action Webhook をアプリに送信します。 アプリが check_run.requested_action Webhook イベントを受信すると、Webhook ペイロード内の requested_action.identifier キーを検索して、どのボタンがクリックされたかを判断し、要求されたタスクを実行できます。

REST API を使って要求されたアクションを設定する方法の詳細な例については、「Checks API で CI テストを作成する」をご覧ください。