GitHub上のBitriseチェック

GitHub アプリ連携

Bitrise GitHub Appを使用してBitrise WorkspaceをGitHubアカウントまたは組織に接続している場合、このセクションで説明する操作を行う必要はありません。GitHub Checksが自動的に機能し、ステータスの更新を提供します。

ただし、OAuth接続をアプリで引き続き使用し、GitHub AppでGitHub Checksを使用することもできます。

Bitrise GitHub Appは、BitriseがGitHubに送信する従来のビルドステータスチェックの拡張版など、さまざまな機能を提供します。この拡張版には、Bitriseビルドサマリーとチェックステータスが含まれます。GitHub上のプルリクエストのDetailsリンクをクリックすると、チェックを表示できます。これにより、GitHubのCheckタブでプルリクエストに添付される、GitHubアプリの詳細なビルドサマリーとビルドステータスが展開表示されます。

チェックステータスには次の3つがあります。

• 成功。
• 失敗。
• 操作が必要（プルリクエストを手動で承認する場合）。

Bitriseアプリを使用してステータスチェックを送信するには、次の2つの操作を行う必要があります。

1. Bitriseアプリをインストールする: これはGitHub.comユーザーにのみ必要です。すでに連携を設定済みのGitHub Enterprise Serverユーザーは、アプリでステータスチェックを有効にする手順に進むことができます。
2. Bitriseアプリを有効にする: Bitrise websiteで機能をオンにし、最初のビルドを実行すると、ブランチ保護ルールでBitriseアプリを選択できるようになります。

GitHub Checks用にBitrise GitHubアプリをインストールする

GitHub.comユーザーとしてBitrise Checksを使用するには、GitHubアプリとしてインストールする必要があります。

Bitrise プロジェクトを所有するworkspaceがBitrise GitHub Appを接続し、Bitrise projectのリポジトリへのアクセスを許可している場合は、ここで説明する手順をスキップしてGitHub Checksの使用を開始できます。

GitHub.comユーザーのみ

GitHub Enterprise Serverユーザーの場合、この手順を行う必要はありません。GitHub Checksを有効にするには、次の操作が必要です。

1. GitHub Enterprise Server連携をインストールする。
2. BitriseでGitHub Checksを有効にする。

1. プロジェクトに対するAdminのロールを持つユーザー、またはEdit workflow権限を持つカスタムロールを持つユーザーで、Bitrise上のプロジェクトを開きます。

2. プロジェクトのメインページで、Project settingsボタンをクリックします。

3. 左側のメニューオプションからIntegrationsを選択します。

4. トグルの下にあるリンクをクリックします。まずBitriseアプリをインストールする必要があるため、まだスイッチを切り替えないでください。

   このリンクをクリックすると、GitHubのBitriseインストールページに移動します。

   

5. Bitriseアプリを追加するユーザーまたはGitHubOrganizationを選択します。

6. Select an option、GitHubアプリのインストール先を選択します:

   • All repositories: 現在および今後のすべてのリポジトリに適用されます。
   • Only select repositories: 必要なリポジトリを選択します。

   これにより、アクセス権のあるリポジトリを確認したり、GitHub Checksを使用してチェック結果を表示したりするなど、Bitriseがあなたに代わって操作することを許可します。

7. Install and authorizeをクリックします。

8. GitHubのプロンプトで、GitHubのパスワードを入力します。

問題がなければ、GitHubのBitriseページに移動します。ページの左上に、BitriseがGitHubアカウントに正常にインストールされたことを示す青いメモが表示されます。

BitriseでGitHub Checksを有効にする

BitriseアプリがGitHubにインストールされると、Bitriseのproject settingsページでGitHub Checksを有効にする必要があります。

GitHub Checksの有効化には制限があります

このトグルは、プロジェクトのProject settingsページでworkspaceの所有者とプロジェクト管理者のみが有効にできますのでご注意ください。

1. プロジェクトに対するAdminのロールを持つユーザー、またはEdit workflow権限を持つカスタムロールを持つユーザーで、Bitrise上のプロジェクトを開きます。

2. プロジェクトのメインページで、Project settingsボタンをクリックします。

3. 左側でRepositoryを選択します。

4. 下にスクロールしてBuild reportingセクションに移動し、GitHub Checksスイッチをオンにします。

   スイッチを切り替えられない場合

   スイッチを切り替えられない場合は、GitHub Checksを有効にできないを確認してください。

5. ビルドをトリガーします。自動でも手動でも実行できます。手動でビルドをトリガーする場合は、ビルド対象の特定のコミットハッシュを指定してください。

   このビルドは、最初のBitriseチェックを実行するために必要です。チェックが完了すると、ブランチ保護ルールでBitrise Checksを選択できるようになります。

以上で完了です。GitHub上でプロジェクトに対して開くプルリクエストは、Bitrise Checksで検証され、（Bitriseでプルリクエストトリガーが正しく設定されている場合）Bitriseで自動的にビルドが開始されます。

GitHub Checksを有効にできない

GitHub Checksを有効にするスイッチを切り替えられない主な理由は、次の2つです。

• 最初にBitrise GitHubアプリをインストールしないと、スイッチを切り替えることはできません。インストールが完了したら、スイッチを右に切り替えて有効にできます。
• すでにBitriseに追加され、Bitrise Checksをインストール済みのアプリのGitHubリポジトリの名前を変更したり移動したりした場合。この場合、リポジトリのGitHub URLは当然変更されています。GitHub Checksスイッチは、GithubとBitriseのURLが完全に一致する場合にのみ機能します（リダイレクトURLは許可されません）。そのため、この場合はアプリのRepository URLを手動で更新する必要があります。

GitHub Checksを無効にする

プロジェクトでGitHub Checksを無効にするには:

プロジェクトのSettingsページでENABLE GITHUB CHECKSスイッチを左に切り替えます。

1. プロジェクトに対するAdminのロールを持つユーザー、またはEdit workflow権限を持つカスタムロールを持つユーザーで、Bitrise上のプロジェクトを開きます。

2. プロジェクトのメインページで、Project settingsボタンをクリックします。

3. 左側でRepositoryを選択します。

4. Build reportingでGitHub Checksトグルを無効にします。

GitHub Checksのテストサマリー

プロジェクトのリポジトリにUIまたはユニットテストが含まれている場合は、Workflow内で適切なテスト用のStepsを使用して実行できます。Deploy to Bitrise.io Stepを使用すると、test resultsがテストレポートページに表示されるほか、GitHub Checksでも確認できます。

たとえば、Androidアプリの場合、Virtual Unit Testing for Android Stepを使用すると、すべてのテスト結果をGitHub Checksで確認できます。

StepによるStepのエラーレポート

CIビルドが実行されると、GitHub Checksのテストサマリーには、左側のサイドバーの別々のタブにStepsの成功したテストと失敗したテストが表示されます。Stepをクリックすると、対応可能なエラーレポート付きで複数のテストが一覧表示された、より詳細なレポートサマリーが表示されます。ビルドサマリーはBitriseタブで確認できます。

GitHub Checksのテストサマリーで詳細情報を表示できるのは、次のStepsのみですのでご注意ください。

• Xcode Test for iOS
• Android Unit Test
• iOS Device Testing
• Virtual Device Testing for Android
• Flutter Test

その他のStepで生成されたテスト結果をDeploy to Bitrise.io Stepにエクスポートするには、次の2つの方法があります。

• Export test results to the Test Reports Stepの使用を強くおすすめします。このStepは、入力に基づいてテスト結果を検索します。
• 必要なファイルを作成してエクスポートする独自のカスタムScript Stepを設定することもできます。

失敗したStepのテスト結果を確認する

ビルドに失敗したテストがある場合、GitHub Checksでそれらを確認する方法は次のとおりです。

1. Bitrise Checkドロップダウンをクリックします。
2. Stepをクリックして、特定のStepのエラーレポートを表示します。

ここから、または、ビルドサマリーから他のStepsをクリックできます。View more details on Bitrise Checksリンクをクリックすると、Bitriseのビルドページに移動します。

GitHubチェックを使用してビルドを再実行する

ロール要件

GitHub Checksを使用してビルドを再実行するには、GitHubアカウントがBitriseに接続されている必要があり、さらにアプリのチームで少なくともDeveloperロールを持っている必要があります。これらの条件が満たされていない場合、再実行チェックはエラーなしで失敗します。

ユーザーロールとロールのチートシートの全一覧については、アプリチームのユーザーロールを確認してください。

GitHub Checksを使用してビルドを再実行する場合:

1. チェックを再実行したいプルリクエストをGitHubで開きます。

2. Checkタブを開きます。

3. Re-run all checksをクリックします。