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

プリセットの作成と管理

プリセットは、再利用可能なリリース設定テンプレートです。自動化ルール、承認タスク、通知、CIのビルド設定を一度定義すれば、複数のリリースに一貫して適用できます。

Apps サブAPIのベースURL: https://api.bitrise.io/release-management/v2/apps/v1。エンドポイント、パラメータ、スキーマの全一覧については、Apps API リファレンスを参照してください。

プリセットの作成Click to copy link​

エンドポイント機能必要なロール
POST /presets新しいプリセットを作成します。リリースマネージャー
GET /presetsアプリのプリセットを一覧表示します。任意
GET /presets/{id}特定のプリセットを取得します。任意
PUT /presets/{id}プリセットを更新します。リリースマネージャー
DELETE /presets/{id}プリセットを削除します。リリースマネージャー

プリセットを作成するには、少なくとも名前と所属するアプリを指定してPOST /presetsを呼び出します。

必須フィールド:

  • app_id: Release Management内のアプリのID。
  • template_name: プリセットの説明的な名前。
curl -X POST "https://api.bitrise.io/release-management/v2/apps/v1/presets" \
  -H "Authorization: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "APP_ID",
    "template_name": "Standard release"
  }'

完全な設定でプリセットを作成するClick to copy link​

プリセットは、自動化ルール、承認タスク、Slack通知、アップロード設定を1つの再利用可能なテンプレートにまとめることができます。

自動化Click to copy link​

自動化ルールは、リリースが特定のステージに達するとCIワークフローをトリガーします。automationフィールドにイベントとワークフローのペアの配列を設定します:

curl -X POST "https://api.bitrise.io/release-management/v2/apps/v1/presets" \
  -H "Authorization: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "APP_ID",
    "template_name": "Standard release",
    "automation": [
      {
        "event_name": "release_candidate_set",
        "workflow_name": "run-tests"
      },
      {
        "event_name": "approvals_completed",
        "workflow_name": "upload-to-store"
      }
    ]
  }'

承認タスクClick to copy link​

承認タスクは、このプリセットを使用するすべてのリリースに対して自動的に作成されます。タスクを定義するにはapprovalsフィールドを設定します:

curl -X POST "https://api.bitrise.io/release-management/v2/apps/v1/presets" \
  -H "Authorization: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "APP_ID",
    "template_name": "Standard release",
    "approvals": [
      {
        "summary": "QA sign-off",
        "description": "Verify all test cases pass on the release build"
      }
    ]
  }'

Slack通知Click to copy link​

リリースの主要なステージでSlack通知を送信するには、notificationsフィールドに設定済みのSlack連携のIDを渡します。詳細については、Slack 連携を参照してください。

curl -X POST "https://api.bitrise.io/release-management/v2/apps/v1/presets" \
  -H "Authorization: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "APP_ID",
    "template_name": "Standard release",
    "notifications": {
      "slack_notification_integration_id": "YOUR_SLACK_INTEGRATION_ID"
    }
  }'

ストアへの自動アップロードClick to copy link​

手動でトリガーすることなく、準備ができ次第ビルドを自動的にストアにアップロードするには、auto_upload: trueを設定します:

curl -X POST "https://api.bitrise.io/release-management/v2/apps/v1/presets" \
  -H "Authorization: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "APP_ID",
    "template_name": "Standard release",
    "auto_upload": true
  }'

これらの設定はすべて1つのリクエストにまとめて指定できます。レスポンスからidを保存してください。これはアプリバージョンの作成時に使用します。

デフォルトプリセット

default: trueを設定すると、このプリセットが新しいリリースに自動的に適用されるプリセットとしてマークされます。アプリごとにデフォルトにできるプリセットは1つだけです。

アプリのプリセットを一覧表示するClick to copy link​

curl -X GET "https://api.bitrise.io/release-management/v2/apps/v1/presets?app_id=APP_ID" \
  -H "Authorization: YOUR_ACCESS_TOKEN" \
  -H "Accept: application/json"

プリセットの更新Click to copy link​

プリセットの設定を置き換えるにはPUT /presets/{id}を使用します。すべてのフィールドは任意です。

curl -X PUT "https://api.bitrise.io/release-management/v2/apps/v1/presets/PRESET_ID" \
  -H "Authorization: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "default": true,
    "auto_upload": false,
    "automation": [
      {
        "event_name": "release_candidate_set",
        "workflow_name": "run-extended-tests"
      }
    ],
    "approvals": [
      {
        "summary": "QA sign-off"
      },
      {
        "summary": "Security review"
      }
    ]
  }'

プリセットの削除Click to copy link​

curl -X DELETE "https://api.bitrise.io/release-management/v2/apps/v1/presets/PRESET_ID" \
  -H "Authorization: YOUR_ACCESS_TOKEN"
既存のリリースへの影響なし

プリセットを削除しても、それを使用して作成されたリリースには影響しません。設定は作成時にリリースにコピーされます。

関連情報