ビルドのトリガーと中止

通話でGit固有のパラメーターを設定できます。 NS branch パラメータは、構築するソースブランチを指定します。これは、git commitのブランチ、またはプルリクエストビルドの場合はプルリクエストのソースブランチのいずれかです。

curl -X 'POST' \
  'https://api.bitrise.io/v0.1/apps/APP-SLUG/builds' \
  -H 'accept: application/json' \
  -H 'Authorization: ACCESS-TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
        "hook_info": {
                "type": "bitrise"
        },
        "build_params": {
                "branch": "main"
        }
 }'

特定のgitcommitまたはgitタグを作成することもできます。コミットハッシュまたはタグのいずれかを設定する必要があります。 build_params 物体。ビルドのコミットメッセージを設定することもできます commit_message パラメータ。

curl -X 'POST' \
  'https://api.bitrise.io/v0.1/apps/APP-SLUG/builds' \
  -H 'accept: application/json' \
  -H 'Authorization: ACCESS-TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "hook_info":{
    "type":"bitrise"
  },
  "build_params": {
    "commit_hash": "0000ffffeeeee",
    "commit_message": "testing"
  }
}'

プルリクエストビルドの場合は、 branch_dest プルリクエストの宛先またはターゲットブランチを設定するパラメータ。 PRはこのブランチにマージされますが、その前に、Bitriseはマージ後のコードの外観に基づいてアプリをビルドします。これは、たとえば、PRビルドがWebhookによって自動的にトリガーされたときに発生します。

NS branch_repo_owner と branch_dest_repo_owner パラメータは、リポジトリの所有者を識別し、プルリクエストに関係するブランチを明確に識別するために使用されます。

PR自体を識別するには、 pull_request_id パラメータ：整数を取ります。たとえば、GitHubのPRの番号。

curl -X 'POST' \
  'https://api.bitrise.io/v0.1/apps/APP-SLUG/builds' \
  -H 'accept: application/json' \
  -H 'Authorization: ACCESS-TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "hook_info":{
    "type":"bitrise"
  },
  "build_params": {
    "branch": "the-pr-branch",
    "branch_dest": "main",
    "commit_hash": "fffff000000eeeeee",
    "pull_request_id": 1
  }
}'

gitプロバイダーがサポートしている場合は、 pull_request_merge_branch PRのブランチの事前マージされた状態を構築するためのパラメータ。別の選択肢は pull_request_head_branch パラメータ：これは、PRのソースを指す必要がある特別なgitrefです。

リポジトリのフォークから開いたPRからビルドをトリガーする場合は、 pull_request_repository_url パラメータ。値はフォークのURLである必要があります。

あなたが持っている場合 webhook 設定すると、Bitriseはビルドに関するステータスレポートをgitプロバイダーに送信します。ただし、これはAPIを介して無効にすることができます。 skip_git_status_report パラメータ。に設定されている場合 true、ビルドステータスレポートは送信されません。

curl -X 'POST' \
  'https://api.bitrise.io/v0.1/apps/APP-SLUG/builds' \
  -H 'accept: application/json' \
  -H 'Authorization: ACCESS-TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "hook_info":{
    "type":"bitrise"
  },
  "build_params": {
    "branch": "the-pr-branch",
    "branch_dest": "main",
    "skip_git_status_report": true
  }
}'

追加で定義できます 環境変数 （Env Vars）ビルド用。これらの追加の変数は、 Secrets と App Env Vars、つまり、ビルド構成で定義されたEnv Var（App Env Varなど）のみを上書きすることはできません。 秘密。

を使用して追加の環境変数を定義します 環境 パラメータ。このパラメータは、 オブジェクトの配列、および配列のすべての項目には、少なくとも mapped_to 財産。これには次のものが含まれている必要があります。

"environments":[
  {"mapped_to":"API_TEST_ENV","value":"This is the test value","is_expand":true},
  {"mapped_to":"HELP_ENV","value":"$HOME variable contains user's home directory path","is_expand":false},
]

デフォルトでは、トリガーされたビルドのワークフローは、 build_params とあなたのアプリの トリガーマップ。これは、Webhookがトリガーマップに基づいてビルドのワークフローを自動的に選択する方法と同じです。

APIを使用すると、この選択を上書きして、使用するワークフローを正確に指定できます。

追加する workflow_id あなたへのパラメータ build_params その特定のビルドに使用するワークフローを指定します。これは、を指定する呼び出しの例です。 deploy ワークフロー：

curl -X 'POST' \
  'https://api.bitrise.io/v0.1/apps/APP-SLUG/builds' \
  -H 'accept: application/json' \
  -H 'Authorization: ACCESS-TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "hook_info": {
        "type": "bitrise"
    },
    "build_params": {
        "branch": "main",
        "workflow_id": "primary"
    }
}'