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とは別物
関連ガイド
What Is a Commit Status?A commit status is a simple state (success, failure, pending, error) that an external system attaches to a co…
What Is a Status Check?A status check is a pass/fail signal a pipeline reports back to a commit or pull request, often required befo…
What Is Branch Protection?Branch protection enforces rules on important branches, like required reviews and status checks, before chang…