メインコンテンツまでスキップ

PRコメントでのビルドの問題の報告

Bitriseのビルドに関するデバッグ情報を、プルリクエスト(PR)のコメントで受け取れます。これにより、ビルドに関する知見がPRのタイムラインに直接表示されるため、問題の解決を迅速化し、コンテキストスイッチを減らせます。

Service Credential UserおよびPRのコメント

PRのコメントは、個人アカウントではなくservice credential userアカウント、または使用している場合はBitrise GitHub Appを使用して投稿される点にご注意ください。

BitriseでのPRコメントの設定Click to copy link​

数回のクリックだけでPRコメントを設定できます:

  1. プロジェクトでAdminロールまたはOwnerロールを持つユーザーで、Bitriseのプロジェクトを開きます。

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

  3. 左側にあるRepositoryをクリックします。

  4. Build reportingまでスクロールし、PR commentsのトグルをオンにします。

    PR CommentsトグルのあるBuild reportingセクション

  5. Configure PR commentsウィンドウでは、information blockはデフォルトですべてオフになっています。PRコメントに含めたい項目を選択してください。information blockは次のとおりです:

    • Build summary: コメントの先頭に表示されるビルドの概要。AIが有効な場合は、ビルドが失敗した理由と最初に確認すべき点も表示されます。

    • Step failures: 失敗したStepsとエラーの詳細を表示します。すべてのStepsが成功した場合は非表示になります。

    • Test failures: 失敗したテストとエラーの詳細を表示します。すべてのテストが成功した場合は非表示になります。テストはビルドのテスト結果から取得されます。テスト結果のデプロイとテスト結果の表示を参照してください。

    • Flaky tests: 不安定なテストと再実行情報を表示します。不安定なテストがない場合は非表示になります。Bitriseが不安定なテストを検出する方法については、不安定なテストの検出と隔離を参照してください。

      information blockとComment modeオプションが表示されたConfigure PR commentsダイアログ

  6. Comment modeでは、single commentまたは複数のコメントのどちらを受け取るかをcomment modeで選択できます。

    • Single comment: PR上の各ビルドは、以前のビルドによる既存のコメントを置き換えるため、PRには最新のビルドのコメントのみが表示されます。

    • Multiple comments: PR上の各ビルドで新しいコメントが追加され、PRのタイムラインに履歴が蓄積されます。

      Comment modeの詳細

      PRのビルドが1つの場合、コメントも1つになります。ただし、同じPR上で異なるWorkflowsが複数ある場合は、選択したComment modeに関わらず複数のコメントになります。同じWorkflowが再トリガーされた場合は、選択したComment modeに応じて、PRに新しいコメントが追加されるか、既存のコメントが更新されます。

  7. 準備ができたら、Save changesをクリックします。

失敗したビルドのみコメントを受け取るClick to copy link​

information blockをすべてチェックした場合、成功したビルドと失敗したビルドの両方でコメントを受け取ります。この場合、成功したビルドのコメントにはビルドの概要が含まれます。以下に例を示します:

reportingbuildproblemsfirstpic.png

reportingbuildproblemssecondpic.png

Bitriseからの成功したビルドに関するコメントを受け取らないようにするには、「Build Summary」ブロックのチェックを外し、必要に応じて他のボックスを選択してください。こうすることで、ビルドに問題がある場合にのみ、以下のようなコメントを受け取るようになります。

reportingbuildproblemsthirdpic.png

PRのコミットへのデバッグ情報の埋め込みに関するFAQClick to copy link​

これらのPRコメントの投稿者は誰ですか?

これは認証の種類によって異なります。OAuthの方法で認証している場合は、Service Credential Userアカウントがコメントを投稿します。これはすべてのGitプロバイダー(例: Github、Gitlab、Bitbucket)に適用されます。

Bitrise GitHubアプリを使用している場合は、関連付けられたBitrise botがコメントを投稿します。

サポートされているGit providersは?

主要なGitプロバイダー(GitHub、GitLab、Bitbucket)はすべてサポートされています。

これらのコメントはすべてのPRに表示されますか?

これはプロジェクトごとのオプトイン機能です。コメントは、プロジェクトでこの機能を有効にした場合にのみ投稿されます。

PR commentsには完全なログが含まれますか?

いいえ。コメントには簡潔なエラーのスニペットと、Bitrise上の完全なビルドおよびStepログへのリンクが含まれます。詳細な内容を確認するには、リンクからBitrise dashboardを開いてください。

多数のワークフローを含むパイプラインビルドの場合はどうなりますか?失敗したStepやテストがどのWorkflowに属しているかがコメントに表示されますか?

有効にすると、パイプラインビルドに対して1件のPRコメントが届きます。情報はWorkflowごとにグループ化されます。

Workflow/Pipelineごとにchange settingsできますか?

いいえ。これはプロジェクトレベルの設定であり、Workflow/Pipelineごとにカスタマイズすることはできません。

同じPRから複数のビルドをトリガーした場合はどうなりますか?コメントは1件になりますか、それとも複数になりますか?

異なる複数のビルドをトリガーした場合(例: PRが3つの異なるパイプラインA、B、Cをトリガーした場合)、複数のコメントを受け取ります。

同じビルドを複数回トリガーした場合(例: PRが同じパイプラインを連続して2回トリガーした場合)、Single commentモードを選択していれば1件のコメントを受け取り、Multiple commentsモードを選択していればmultiple commentsを受け取ります。