Skip to main content

アプリのビルドの管理

概要

Bitrise APIを使用して、アプリのビルドを一覧表示したり、特定のビルドに関するすべての情報を取得したり、ビルドログを表示したり、200日以上経過したアーカイブビルドを表示したりできます。

BitriseAPIを使用してリストすることができます アプリの ビルド、特定のビルドに関するすべての情報の取得、ビルドログの表示、および200日より古いアーカイブビルドの表示。

表1 アプリのビルドの管理に使用されるエンドポイント

エンドポイント

関数

アプリのチームで必要な役割

GET / apps / {app-slug} / archived-builds

指定したアプリのアーカイブビルドを一覧表示します。

テスター/QA

GET / apps / {app-slug} / build-workflows

指定されたアプリに対していつでもトリガーされたワークフローを一覧表示します。

テスター/QA

GET / apps / {app-slug} / builds

指定したアプリのすべてのビルドを一覧表示します。

テスター/QA

GET / apps / {app-slug} / builds / {build-slug}

特定のアプリの指定されたビルドを取得します。

テスター/QA

GET /apps/{app-slug}/builds/{build-slug}/bitrise.yml

取得する bitrise.yml 指定されたアプリのビルドの1つのファイル。

デベロッパー

GET / apps / {app-slug} / builds / {build-slug} / log

アプリの指定されたビルドのビルドログを取得します。

デベロッパー

GET / builds

認証されたアカウントでアクセスできるすべてのBitriseビルドを一覧表示します。

該当なし


アプリのビルドデータの表示

APIを使用して、関連するすべてのビルド情報にアクセスできます。

あなたはアプリのすべてのビルドを取得することができます GET /apps/{app-slug}/builds 終点。ビルドに使用されたワークフローなどの追加のパラメーターを設定して、フィルターとして機能させることができます。次の形式でパラメータを設定します。

GET /apps/{app-slug}/builds?parameter_name=parameter_value&other_parameter_name=other_parameter_value

パラメータの完全なリストは、 APIリファレンス ドキュメンテーション。

200日間のビルド保持

ビルド アプリのページには、過去200日間のビルドのみが表示されます。あなたがいる場合も同じ制限が適用されます 特定のビルドを検索する ページ上。この制限は、API呼び出しにも適用されます。 GET/apps/{app-slug}/builds エンドポイントおよび関連するエンドポイントは、過去200日間のビルドのみを返すことができます。

ただし、正確なビルドURLがわかっている場合は、200日より古いビルドを表示できます。古いビルドを表示する必要があるが、正確なビルドURLがわからない場合は、サポートチームにお問い合わせください。

例1 ビルドしたビルドのリスト 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'

応答(この例では、応答は単一のビルドのみを示しています):

{
  "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}。また、を表示することができます bitrise.yml 追加することによるビルドのファイル /bitrise.yml URLの最後まで。

例2 ステータス整数を使用して失敗したビルドを一覧表示する

ステータス整数を使用して、ビルドステータスに基づいてビルドをフィルタリングできます。ステータス整数は次のとおりです。

  • 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リファレンス ドキュメンテーション。

アプリのアーカイブされたビルドの一覧表示

デフォルトでは、200日以内のビルドのみを表示できます。これは、ほとんどのAPIエンドポイントにも当てはまります。ただし、を呼び出すことで、古いアーカイブビルドを表示することもできます。 GET /apps/{app-slug}/archived-builds 終点。

エンドポイントには、2つの必須パラメーターがあります。

両方のパラメーターはUnixタイムスタンプを使用して表される日付であり、両方とも必須です。つまり、アーカイブされたビルドを表示する正確な期間を指定する必要があります。

例1 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'