アプリのビルドの管理
Bitrise API を使用すると、アプリのビルドの一覧表示、特定のビルドに関するすべての情報の取得、ビルドログの表示、200日以上前のアーカイブ済みビルドの表示を行うことができます。
| エンドポイント | 機能 | アプリのチームで必要なロール |
|---|---|---|
| GET /apps/{app-slug}/archived-builds | 指定したアプリのアーカイブ済みビルドを一覧表示します。 | Tester/QA |
| GET /apps/{app-slug}/build-workflows | 指定したアプリに対してこれまでにトリガーされたワークフローを一覧表示します。 | Tester/QA |
| GET /apps/{app-slug}/builds | 指定したアプリのすべてのビルドを一覧表示します。 | Tester/QA |
| GET /apps/{app-slug}/builds/{build-slug} | 指定したアプリの指定したビルドを取得します。 | Tester/QA |
| GET /apps/{app-slug}/builds/{build-slug}/bitrise.yml | 指定したアプリのビルドの bitrise.yml ファイルを取得します。 | Developer |
| GET /apps/{app-slug}/builds/{build-slug}/log | アプリの指定したビルドのビルドログを取得します。 | Developer |
| GET /builds | 認証済みアカウントでアクセスできる Bitrise のすべてのビルドを一覧表示します。 | N/A |
アプリのビルドデータを表示するClick to copy link
API を使用すると、ビルドに関するすべての関連情報にアクセスできます。
GET /apps/{app-slug}/builds エンドポイントを使用すると、アプリのすべてのビルドを取得できます。ビルドに使用された Workflow など、additional parameters をフィルターとして設定できます。パラメータは次の形式で設定してください。
GET /apps/{app-slug}/builds?parameter_name=parameter_value&other_parameter_name=other_parameter_value
パラメータの全一覧については、API リファレンスドキュメントを参照してください。
アプリの Builds ページには、過去200日間のビルドのみが表示されます。ページ上で特定のビルドを検索する場合も同じ制限が適用されます。この制限はほとんどの API 呼び出しにも適用され、GET/apps/{app-slug}/builds エンドポイントおよび関連するエンドポイントでは過去200日間のビルドのみを返すことができます。
ただし、200日以上前のビルドを取得する方法が2つあります。
- 正確なビルドの URL がわかっている場合は、その ビルドにアクセスできます。
GET/apps/{app-slug}/archived-buildsAPI エンドポイントを使用できます。アプリのアーカイブ済みビルドを一覧表示する。
development ブランチをビルドしたビルドを一覧表示する
リクエスト:
curl -X GET 'https://api.bitrise.io/v0.1/apps/$APP-SLUG/builds?branch=development&workflow=primary' -H 'accept: application/json' -H 'Authorization: $ACCESS_TOKEN'
レスポンス(この例では、レスポンスには1つのビルドのみが表示されています):
{
"data": [
{
"triggered_at": "2022-07-18T13:12:35Z",
"started_on_worker_at": null,
"environment_prepare_finished_at": null,
"finished_at": "2022-07-18T13:12:47Z",
"slug": "294e02x8-554c-44f8-84a5-59867a66df83",
"status": 3,
"status_text": "aborted",
"abort_reason": "User X requested to abort this build.",
"is_on_hold": false,
"is_processed": true,
"is_status_sent": false,
"branch": "development",
"build_number": 8,
"commit_hash": null,
"commit_message": null,
"tag": null,
"triggered_workflow": "primary",
"triggered_by": null,
"machine_type_id": "g2.4core",
"stack_identifier": "osx-xcode-13.3.x",
"original_build_params": {
"branch": "development"
},
"pipeline_workflow_id": null,
"pull_request_id": 0,
"pull_request_target_branch": null,
"pull_request_view_url": null,
"commit_view_url": null,
"credit_cost": null
}
],
"paging": {
"total_item_count": 1,
"page_item_limit": 50
}
}
特定のビルドについて同じデータを取得するには、GET /apps/{app-slug}/builds/{build-slug} を呼び出します。また、URL の末尾に /bitrise.yml を追加することで、ビルドの bitrise.yml ファイルを表示することもできます。
ステータス整数を使用すると、ビルドステータスに基づいてビルドをフィルタリングできます。ステータス整数は次のとおりです。
- 0 - 未完了(開始中、実行中、または保留中のビルド)
- 1 - 成功
- 2 - 失敗
- 3 - 失敗による中断
- 4 - 成功による中断
リクエスト:
curl -X GET 'https://api.bitrise.io/v0.1/apps/$APP-SLUG/builds?branch=development&status=2' -H 'accept: application/json' -H 'Authorization: $ACCESS_TOKEN'
レスポンス(この例では、失敗したビルドが2つありました):
{
"data": [
{
"triggered_at": "2022-08-01T09:20:11Z",
"started_on_worker_at": "2022-08-01T09:20:15Z",
"environment_prepare_finished_at": "2022-08-01T09:20:15Z",
"finished_at": "2022-08-01T09:21:32Z",
"slug": "104d4527-f6a0-4362-b595-77349ccc1264",
"status": 2,
"status_text": "error",
"abort_reason": null,
"is_on_hold": false,
"is_processed": true,
"is_status_sent": false,
"branch": "main",
"build_number": 26,
"commit_hash": null,
"commit_message": null,
"tag": null,
"triggered_workflow": "Appetize.io",
"triggered_by": "manual-danicsorba",
"machine_type_id": "g2.4core",
"stack_identifier": "osx-xcode-13.2.x",
"original_build_params": {
"branch": "main",
"workflow_id": "Appetize.io"
},
"pipeline_workflow_id": null,
"pull_request_id": 0,
"pull_request_target_branch": null,
"pull_request_view_url": null,
"commit_view_url": null,
"credit_cost": 4
},
{
"triggered_at": "2022-04-27T10:25:47Z",
"started_on_worker_at": "2022-04-27T10:26:24Z",
"environment_prepare_finished_at": "2022-04-27T10:26:24Z",
"finished_at": "2022-04-27T10:27:16Z",
"slug": "b8599c39-201d-4cc9-8ef5-f28b75b7d910",
"status": 2,
"status_text": "error",
"abort_reason": null,
"is_on_hold": false,
"is_processed": true,
"is_status_sent": false,
"branch": "main",
"build_number": 25,
"commit_hash": null,
"commit_message": null,
"tag": null,
"triggered_workflow": "Appetize.io",
"triggered_by": "manual-danicsorba",
"machine_type_id": "g2.4core",
"stack_identifier": "osx-xcode-13.2.x",
"original_build_params": {
"branch": "main",
"workflow_id": "Appetize.io"
},
"pipeline_workflow_id": null,
"pull_request_id": 0,
"pull_request_target_branch": null,
"pull_request_view_url": null,
"commit_view_url": null,
"credit_cost": 2
}
],
"paging": {
"total_item_count": 2,
"page_item_limit": 50
}
}
これらのエンドポイントは、API リファレンスドキュメントで試すことができます。
アプリのアーカイブ済みビルドを一覧表示するClick to copy link
デフォルトでは、200日以内のビルドのみを表示できます。これはほとんどの API エンドポイントにも当てはまります。ただし、GET /apps/{app-slug}/archived-builds エンドポイントを呼び出すことで、それより古いアーカイブ済みビルドを表示することもできます。
このエンドポイントには、必須のパラメータが2つあります。
- after
- before
どちらのパラメータもUnixタイムスタンプで表される日付であり、両方とも必須です。つまり、アーカイブ済みビルドを表示したい正確な期間を指定する必要があります。
2021-01-01から2022-01-01までのすべてのアーカイブ済みビルドを一覧表示するcurl -X 'GET' \
'https://api.bitrise.io/v0.1/apps/APP-SLUG/archived-builds?after=1609459200&before=1640995200' \
-H 'accept: application/json' \
-H 'Authorization: THE_ACCESS_TOKEN'