launch-trigger-and-monitor-launch-deployments

Launch デプロイを実行して監視する

説明

特定の環境に対して Launch のデプロイを実行し、完了するまでステータスをポーリングします。デプロイに失敗した場合、またはキャンセルされた場合は、デプロイログを取得し、考えられる原因を次の手順の提案とともに診断します。

使用する場面

既知のプロジェクトと環境に対する Launch デプロイを自動化し、進行状況を監視して、失敗時の診断情報を提示する必要がある場合に使用します。確定的なデプロイステータスの確認と、ログに基づくトラブルシューティングが必要な CI/CD やオペレーターのワークフローに適しています。

ユーザーの課題

ユーザーには、Launch で確実にデプロイを開始し、完了まで追跡し、失敗した場合はその理由をすばやく把握する方法が必要です。このスキルにより、手動でのポーリングを減らし、デプロイの失敗を次のアクションにつなげやすくします。

成功条件

意図したプロジェクトと環境に対してデプロイが実行されます。 終端状態に達するまで、一定の間隔でステータスがポーリングされます。 デプロイに失敗またはキャンセルされた場合、プロセスはゼロ以外のコードで終了します。 デプロイに失敗した場合、デプロイログが取得され、考えられる原因と次の手順とともに要約されます。 すべてのデプロイで、実行前にプロジェクトと環境の明示的な確認が必要です。本番環境が対象の場合は、さらに検証されます。

想定される入力

• project_uid
• environment_uid
• 任意のデプロイペイロードまたはビルド参照
• デプロイごとの明示的な確認（本番環境かどうかを問いません）
• アプリ、ブランチ、ビルドソースに関する利用可能なコンテキスト

想定される出力

• デプロイ UID と初回の実行応答
• ポーリング中のステータス更新
• 終端ステータスと終了コード
• 失敗時のデプロイログの要約
• 推奨される次の手順と考えられる根本原因

ユーザーリクエストの例

• プロジェクト abc123 の環境 prod456 にデプロイを実行し、完了するまで監視してください。
• 最新のビルドをステージングにデプロイし、失敗したかどうかを教えてください。
• デプロイに失敗した場合は、ログを確認して何が問題だったかを説明してください。
• Launch のデプロイを 10 秒ごとにポーリングし、失敗時はゼロ以外のコードで終了してください。

ワークフローの概要

プロジェクトと環境の識別子を検証します。 対象が許可されていることを確認し、環境を問わず、デプロイの実行前にそのデプロイについて明示的な承認を得ます。 Launch API を使用してデプロイを実行します。 終端状態に達するまで、10 秒ごとにデプロイステータスをポーリングします。 ステータスが failed または cancelled の場合は、デプロイログを取得して分析します。 ステータス、ログから判明した内容、推奨される次の手順を簡潔にまとめて返します。

手順

デプロイの実行

必要なペイロードを指定して POST /projects/{project_uid}/environments/{environment_uid}/deployments を呼び出します。リクエストを送信する前に、対象環境を検証します。

ステータスのポーリング

10 秒ごとにデプロイステータスを確認します。デプロイが終端状態に達するか、失敗条件が検出されるまで続けます。

失敗時の即時終了

ステータスが failed または cancelled になった場合は、ゼロ以外のコードで終了します。終端の失敗状態に達した後は、ポーリングを続けないでください。

失敗時のログ取得

デプロイに失敗した場合は、GET /projects/{project_uid}/environments/{environment_uid}/deployments/{deployment_uid} を呼び出し、デプロイログの詳細を調べます。

診断と推奨事項

ログから最も可能性の高い原因を要約し、不足している前提条件や設定上の問題があれば記載して、次に取るべき修正アクションを提案します。

出力形式

まず、簡潔なデプロイの概要を返します。 デプロイ UID、環境 UID、最終ステータスを含めます。 失敗時には、ログに基づく簡潔な診断と次の手順を含めます。 デプロイトークン、シークレット、環境変数を公開しないでください。 デプロイに失敗またはキャンセルされた場合は、ゼロ以外の終了コードを使用します。

ツールに関する注意事項

デプロイのトリガーとステータス確認には Launch API を使用してください。 失敗の分析には、デプロイ詳細／ログエンドポイントを使用してください。 デプロイ前に対象環境を検証してください。 デプロイのたびに明示的な確認を求め、本番環境では追加の確認を行ってください。 レビューなしで本番環境へ自動デプロイしないでください。

セキュリティ

デフォルト設定

• デプロイトークンや環境シークレットを決して公開しないでください。
• トリガーを実行する前にデプロイ対象を検証してください。
• デプロイのたびに明示的な確認を求めてください。
• レビューなしで本番環境へ自動デプロイしないでください。

破壊的な操作

デプロイのトリガーは外部への副作用として扱ってください。デプロイのトリガーを実行する前に、必ずユーザーの明示的な確認を求めてください。既存のデプロイの監視や診断を求めるリクエストでは、新たなデプロイをトリガーしません。ユーザーがリクエストし、対象が本番環境以外の場合を除き、失敗したデプロイを自動で再試行しないでください。

シークレット

API トークン、デプロイトークン、環境シークレットを表示、ログ出力、またはエコーしないでください。エラー、ログ、要約に含まれる機密値はマスキングしてください。

環境変数

必要に応じて環境変数を使った設定を受け付けますが、その値を決して公開しないでください。デプロイを試みる前に、必須の変数が設定されていることを検証してください。

製品コンテキスト

• • 製品：Launch
• • 説明：Contentstack Launch：Contentstack を利用するフロントエンド向けのホスティング、デプロイ、エッジ配信、サーバーレス関数、環境管理、CI/CD。
• • 製品の安全ルール： - デプロイトークンや環境シークレットを決して公開しないでください。
• トリガーを実行する前にデプロイ対象を検証してください。
• デプロイのたびに明示的な確認を求めてください。
• レビューなしで本番環境へ自動デプロイしないでください。
• • デフォルトのツール：["Launch API", "Projects", "Environments", "Deployments", "Serverless Functions", "Edge Delivery", "Custom Domains"]
• • デフォルトのコネクター：["Launch Proxy", "GitHub", "CI/CD Pipelines"]

例

デプロイをトリガーして監視する（少数ショットの例＊）

ユーザー： プロジェクト abc123 を環境 staging456 にデプロイし、完了するまでポーリングを続けてください。

アシスタント： 1. プロジェクトと環境を検証します。 2. POST /projects/abc123/environments/staging456/deployments を介してデプロイをトリガーします。 3. 10 秒ごとにステータスをポーリングします。 4. デプロイのステータスが failed または cancelled になった場合、デプロイログを取得し、原因を要約します。 5. 最終ステータスを返し、失敗時はゼロ以外の終了コードで終了します。

＊トリガー → ポーリング → 失敗時の早期終了 → 診断の動作を示します。

本番環境では確認が必要（例外ケース＊）

ユーザー： 今すぐ本番環境にデプロイしてください。

アシスタント： 対応できますが、本番環境へのデプロイには明示的な確認が必要です。続行する前に、対象となるプロジェクトと環境の UID を指定して確認してください。

＊本番環境の安全確認を示します。