Skip to content
Latchkey

Check Runとは?

check runは、appまたはCIシステムがGitHub Checks APIを通じて特定のcommitに対して報告する個別の検証です。status(queued、in progress、completed)とconclusion(success、failure、neutral)を持ち、正確な行を指し示すannotationを添付できます。複数のcheck runは、commitごとに1つのcheck suiteにまとめられます。

なぜ重要か

check runは、赤か緑のドットだけでなく行レベルのannotationを伴って、CIがpull request上に結果を表示する、リッチで構造化された方法です。check runはbranch protectionに供給されます。指定したcheck runが成功するまでmergeをブロックできます。

関連する概念

  • commitごとにcheck suiteにまとめられる
  • 特定の行にannotationを添付できる
  • 古いcommit status APIとは別物

関連ガイド