ステータスチェックについて
ステータスチェックを利用すると、コントリビュート先のリポジトリの条件をコミットが満たしているかどうかを知ることができます。
ステータスチェックは、リポジトリにプッシュをするたびに実行される継続的インテグレーションのビルドのような、外部のプロセスに基づいています。 You can see the pending, passing, or failing state of status checks next to individual commits in your pull request.
書き込み権限があるユーザまたはインテグレーションなら誰でも、リポジトリのステータスチェックを任意のステータスに設定できます。
ブランチへの最後のコミットの全体的なステータスは、リポジトリのブランチページあるいはリポジトリのプルリクエストのリストで見ることができます。
リポジトリでステータスチェックが必須となっているなら、ブランチを保護されたブランチにマージする前には必須ステータスチェックをパスしていなければなりません。詳しい情報については「ステータスチェック必須について」を参照してください。
GitHub Enterpriseでのステータスチェックの種類
GitHub Enterprise のステータスチェックには 2 種類あります。
- チェック
- ステータス
Checks are different from statuses in that they provide line annotations, more detailed messaging, and are only available for use with GitHub Apps.
Organization オーナー、およびリポジトリにプッシュアクセスを持つユーザは、GitHub Enterprise の API でチェックおよびステータスを作成できます。 詳細は GitHub 開発者ドキュメンテーション 中の「チェック」および「 ステータス」を参照してください。
チェック
When checks are set up in a repository, pull requests have a Checks tab where you can view detailed build output from status checks and rerun failed checks.
コミットの特定の行でチェックが失敗している場合、その失敗、警告、注意に関する詳細がプルリクエストの [Files] タブの関連するコードの横に表示されます。
[Conversation] タブの下のコミットドロップダウンメニューを使って、プルリクエスト中のさまざまなコミットのチェックのサマリー間を行き来できます。
個々のコミットに関するチェックのスキップとリクエスト
リポジトリがプッシュに対して自動的にチェックをリクエストするように設定されている場合、プッシュする個々のコミットについてチェックをスキップできます。 リポジトリがプッシュに対して自動的にチェックをリクエストするよう設定されていない場合、プッシュする個々のコミットについてチェックをリクエストできます。 これらの設定に関する詳しい情報については、GitHub 開発者ドキュメンテーション 中の「チェックスイート」を参照してください。
コミットに対するチェックをスキップもしくはリクエストするには、以下の追加行のいずれかをコミットメッセージの末尾に追加します:
-
コミットのチェックをスキップには、コミットメッセージと変更の短く意味のある説明を入力してください。 コミットの説明の後に、閉じる引用符の代わりに 2 つの空の行を追加し、その後に
skip-checks: true
と続けます。$ git commit -m "Update README. > > skip-checks: true
-
コミットのチェックをリクエストするには、コミットメッセージと変更の短く意味のある説明を入力してください。 コミットの説明の後に、閉じる引用符の代わりに 2 つの空の行を追加し、その後に
request-checks: true
と続けます:$ git commit -m "Refactor usability tests. > > request-checks: true