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

Gitホスティングプロバイダーへのビルドステータスの報告

Bitriseは、ビルドステータスレポートをGitプロバイダー(GitHub/GitLab/Bitbucket)に送信できます。これにより、開発者は迅速に情報に基づいた判断を下せるようになり、プラットフォーム間を切り替える必要がなくなります。

同じコミットが複数のビルドをトリガーしても、ビルドごとにステータスレポートを送信します。変数を使用してレポートをカスタマイズし、より詳細な情報や具体的な内容を伝えることができます。

ステータスレポートは、プロジェクトレベルまたはWorkflows、Pipelinesのレベルで設定できます。

Pipelineレポート

トリガーされたエンティティがPipelineの場合、そのビルドステータスは報告されますが、Pipeline内の個々のWorkflowsは個別のステータスを報告しません。Pipelineのステータスレポートに加えて、Bitriseはテスト結果をエクスポートしているStepsのテスト結果ステータスも報告します。

ビルドステータスレポートの設定Click to copy link​

BitriseでGitステータスレポートを設定する方法は2つあります。

Bitrise website IPアドレスを許可リストに追加する

コードの保存に何らかの形のセルフホスト型ソリューションを使用している場合、Bitrise websiteとそのバックグラウンドワーカーの静的IPアドレスを許可リストに追加する必要がある場合があります。これにより、bitrise.ymlファイルを自分のリポジトリに保存したり、Bitriseからビルドステータスの更新を受信したりといった機能を使用できるようになります。Bitrise websiteのIPアドレス。

どちらの方法でも、プロジェクトレベルとWorkflowまたはPipelineレベルの両方のレポートを送信できます。

ブランチ保護ルールClick to copy link​

ビルドステータスレポートの設定を更新する際、Gitプロバイダーでブランチ保護ルールを変更する必要がある場合があります。

Workflow/Pipelineレベルのステータスレポートを使用する場合、またはtarget-idの動的変数を使用する場合、実行されたWorkflowまたはPipelineごとに異なるステータスチェックが作成されます。つまり、すべてのプルリクエストですべてのチェックが必須である場合、複数のブランチ保護ルールが必要になることがあります。

カスタムステータスレポートClick to copy link​

カスタムGitステータスレポートを作成できます。コミットステータスメッセージは、チームの好みや要件に合わせて調整できます。レポートに名前を付けることで、Gitプロバイダーのサイトですぐに識別できるようになります。ステータスレポートの名前には、プロジェクトのタイトルやWorkflowの名前など、動的変数を使用できます。

デフォルトのステータスレポート名はci/bitrise/<project_slug>/<event_type>です。レガシーのGitHub Checksレポートの場合、デフォルト名はBitriseです。

カスタムレポートは、次の2つのレベルで設定できます。

  • プロジェクトレベルのレポートは、プロジェクト内のすべてのWorkflowsとPipelinesに適用されます。これにより、同じプロジェクト内のすべてのビルドのステータスに一貫した形式が提供されます。
  • 個々のWorkflowsまたはPipelinesのレベル。これらのカスタムレポートは、一般的なプロジェクトレベルのステータスレポートより優先されます。これは、特定のビルドステージについてより詳細な情報を提供したい場合や、ビルドの種類を区別したい場合に役立ちます。
文字数制限と使用可能な文字

ステータスメッセージは簡潔にしてください。上限は100文字で、BitBucketでは40文字までしか使用できません。

次の文字がサポートされています: , . / ( ) : - _ (space) (a-z) (A-Z) (0-9) &lt; &gt; [ ] |

プロジェクトレベルのステータスレポートClick to copy link​

プロジェクトレベルでカスタムステータスレポートを作成するには、設定YAMLファイルのappの下にstatus_report_nameプロパティを追加します。これには静的な値を指定できます。

app:
status_report_name: 'Bitrise build'

または、動的な値を使用することもできます。

app:
status_report_name: 'PR check for <project_title>'

複数の動的な値を組み合わせることもできます。

app:
status_report_name: 'Executing <target_id> for <project_title>'

target_idの使用をお勧めします。これは、ビルドが使用するWorkflowまたはPipelineの名前です。この変数を使用すると、同じコミットに対する異なるWorkflows/PipelinesからのGitコミットステータスが互いに上書きされることはありません。

使用可能な変数については、こちらをご覧ください: 動的変数。

Workflow/PipelineレベルのステータスレポートClick to copy link​

Workflowレベルでカスタムステータスレポートを作成するには、設定YAMLファイル内のWorkflowの名前の下にstatus_report_nameプロパティを追加します。

workflows:
build-ios:
status_report_name: build-report

同様に、Pipelineレベルで作成するには、Pipelineの名前の下にプロパティを追加します。

pipeline:
deploy-pipeline:
status_report_name: build-report
追加のレポートなし

Pipeline内のWorkflowにstatus_report_nameプロパティが設定されている場合、WorkflowがPipelineの一部として実行されても、追加の個別ステータスレポートは生成されません。Workflowが単独のビルドとして実行された場合にのみ、ステータスレポートにカスタム名が追加されます。

複数の動的な値を組み合わせることもできます。

pipeline:
deploy-pipeline:
status_report_name: 'Executing <target_id> for <project_title>'

target_idの使用をお勧めします。これは、ビルドが使用するWorkflowまたはPipelineの名前です。この変数を使用すると、同じコミットに対する異なるWorkflows/PipelinesからのGitコミットステータスが互いに上書きされることはありません。

使用可能な変数については、こちらをご覧ください: 動的変数。

ブランチ保護ルール

プロジェクトベースのステータスレポートからWorkflowレベルのステータスレポートに切り替える場合、ブランチ保護ルールを更新する必要がある場合があります。

Workflow EditorでWorkflowレベルのステータスレポートを設定することもできます。Workflowを開き、Propertiesタブに移動して、Git status nameの入力欄を見つけてください。

workflow-level-status-report.png

動的変数Click to copy link​

ステータスレポートには、次の動的変数を使用できます。

変数名説明
project_slugBitrise上のプロジェクトの一意の英数字識別子で、プロジェクトのURLの一部です。
project_titleプロジェクトの人間が読める形式のタイトル。
target_idビルドに使用された特定のWorkflowまたはPipelineの名前。
event_typeステータスレポートをトリガーしたイベントの種類を表します。指定できる値は次のとおりです。 - pr: プルリクエスト(GitHub、Bitbucket) - mr: マージリクエスト(GitLab) - push: コードプッシュ(GitLab、GitHub、Bitbucket - tag: Gitタグ(GitLab、GitHub、Bitbucket)

ドキュメントのみのプルリクエストで必須チェックを通過させるClick to copy link​

Gitプロバイダーのブランチ保護ルールでステータスレポートが必須チェックとして設定されている場合、すべてのプルリクエストはマージされる前にそのチェックを生成する必要があります。これは、ドキュメントやMarkdownファイルのみを編集するプルリクエストなど、CIを必要としない変更では問題になります。ビルドがトリガーされない場合、ステータスは報告されず、必須チェックは保留のままとなり、マージがブロックされます。

ビルドをスキップしないでください。スキップされたビルドは何も報告しません。代わりに、必須チェックを報告しつつ実際の処理は行わないPipelineをトリガーしてください。この中のすべてのWorkflowは、run_if式によってスキップされます。スキップされたWorkflowは成功としてカウントされるため、Pipelineは正常に終了してグリーンのステータスを報告します。また、スキップされたWorkflowsはbuild machineを起動しないため、クレジットは消費されません。

このPipelineには実際のCI Pipelineと同じstatus_report_nameを設定し、両方が同じ必須チェックを満たすようにします。それぞれをchanged_filesでスコープしてください。

pipelines:
# Real CI. Runs on code changes.
ci:
status_report_name: ci
triggers:
pull_request:
- changed_files: "app/**"
workflows:
build: {}

# Documentation-only pull requests. Reports the same ci check, but does no work.
docs-only:
status_report_name: ci
triggers:
pull_request:
- changed_files: "**/*.md"
workflows:
no-op:
run_if:
expression: "false"
workflows:
build:
steps:
- git-clone@8: {}
# ... your build and test Steps ...
no-op:
steps: []
ドキュメントの変更とコードの変更は別々のプルリクエストに分ける

このパターンが確実に機能するのは、プルリクエストにドキュメントの変更またはコードの変更のどちらか一方のみが含まれている場合に限られます。changed_files条件は、変更されたファイルのいずれかがそのパターンに一致すると一致するため、Markdownファイルとコードファイルの両方に変更を加えたプルリクエストは、両方のPipelinesをトリガーします。すると両方が同じコミットに対して同じciチェックを報告し、成功したdocs-onlyのレポートが実際のビルドの結果を上書きしてしまい、失敗したビルドがマージされてしまう可能性があります。ドキュメントのみの変更は、専用のプルリクエストにまとめてください。両方を含める必要がある場合は、docs-onlyPipelineに頼るのではなく、完全なCIを実行してください。

ビルドステータスレポートのトラブルシューティングClick to copy link​

ビルドがGitホスティングプロバイダー(GitHub、GitLab、またはBitbucket)にステータスレポートを送信しない場合は、原因を調査する必要があります。考えられる問題を見ていきましょう。

service credential userの確認Click to copy link​

bitrise.io上のアプリのservice credential userは、自分のBitriseアカウントをGitホスティングアカウントに連携し、そのGitアカウントでのアプリのリポジトリへのアクセス権を持っている必要があります。

service credential userを確認し、Git接続をテストできます。

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

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

  3. bitrise.ioでyour appのページに移動します。

  4. Service credential userセクションを見つけます。

    現在のユーザー

    図では、現在アクティブなユーザーはservice credential userです。service credential userが別のユーザーである場合、ボタンのテキストを含め、見た目が少し異なります。

  5. Test <Git provider> connectionボタンをクリックして、ユーザーのGit接続をテストします。

リポジトリの権限とURLの確認Click to copy link​

WorkspaceまたはチームにBitriseアクセスを付与していることを確認してください。リポジトリを所有するGitHub WorkspaceまたはBitbucketチームにBitriseアクセスを付与していない、あるいはアクセスを拒否している可能性があります。

URLリポジトリが最新であることを確認してください。

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

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

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

  4. リポジトリのURLを確認し、正しいことを確認します。

    apps-repository-url.png