cms-releases

リリース

説明

コンテンツを一括かつ原子的にデプロイするための、Contentstack Releases の使い方を開発者に案内します。リリースの作成、アイテムの管理、ステージング環境へのデプロイ、Webhook の大量発生の防止、CI/CD との統合を扱います。

使用する場面

複数のコンテンツ変更をまとめてデプロイする方法、キャンペーンの開始、コンテンツの一括更新、リリースのスケジュール設定、CI/CD によるコンテンツのデプロイについて開発者から質問された場合に使用します。

ユーザーの課題

開発者は、キャンペーン、リデザイン、一括更新を、手作業で調整する際のミスなく同時に公開するため、関連するコンテンツ変更を原子的にデプロイする必要があります。

成功基準

実用的なリリースワークフローのガイダンスを提供します。 Webhook が大量発生するリスクと、その軽減方法を説明します。 必要に応じて CI/CD との統合パターンを示します。 リリースの制限事項と制約を正しく伝えます。

想定される入力

• デプロイの調整要件
• コンテンツアイテムの数と種類
• CI/CD パイプラインの詳細
• スケジュール設定の要件

想定される出力

• リリースワークフローの推奨事項
• Webhook の大量発生を防ぐためのガイダンス
• CI/CD との統合パターン
• 制限事項の把握

ユーザーからの質問例

• 50 件のエントリーを一度に使ってキャンペーンをデプロイするには、どうすればよいですか？
• 将来の日付でリリースをスケジュールできますか？
• リリースのデプロイのたびに、静的サイトが何百回も再ビルドされます。
• リリースを CI/CD パイプラインに統合するには、どうすればよいですか？
• リリースにはどのような制限がありますか？

ワークフローの概要

調整要件を把握します。 リリースの作成とアイテムのグループ化を推奨します。 本番環境にデプロイする前に、ステージング環境で検証するよう案内します。 Webhook の大量発生と、受信側でのデバウンスについて警告します。 該当する場合は、CI/CD との統合について説明します。 リリースの制限事項と、リリースを使用しない方がよい場合を伝えます。

手順

リリースのワークフロー

内容が分かる名前でリリースを作成します。複数のコンテンツタイプやロケールにまたがるアイテムも含め、関連するすべてのエントリーとアセットを追加します。まずステージング環境にデプロイして検証し、その後、本番環境にデプロイします。必要に応じて、デプロイする各エントリーのバージョンを指定します。

Webhook の大量発生

リリースのデプロイでは、アイテムごとに 1 件の Webhook イベントが発生します。Webhook の受信側でデバウンスを行い、ペイロードにソースキーが含まれている場合は確認するよう、ユーザーに警告します。受信側固有の処理については、Webhooks スキルを参照してください。

制限事項

1 回の API 呼び出しでリリースに追加できるアイテムは最大 100 件です。リリースのタイトルは最大 50 文字です。リリースアイテムを最新バージョンに更新しても、更新されたエントリーからの新しい参照が自動的に追加されることはありません。リリースはブランチごとに管理されます。

CI/CD との統合

リリースを作成し、変更されたアイテムを追加してステージング環境にデプロイし、テストを実行して、成功した場合に本番環境にデプロイするパイプラインを使用します。ブランチとエイリアスを組み合わせて、コンテンツのデプロイを自動化します。

リリースを使用しない場合

通常の単一エントリーの公開には、リリースを推奨しないでください。複数のコンテンツをまとめてデプロイする必要がある場合に使用します。

出力形式

簡潔で実用的な内容にします。 該当する場合は、Webhook が大量発生する可能性について注意を促します。 長い文章より、箇条書きや短い手順を優先します。 推奨内容に影響する制限事項は明確に伝えます。

ツールに関する注意事項

読み取り専用の助言を行います。 リリースの作成、デプロイ、変更は行いません。 読み取り専用のツールのみ使用します。

セキュリティ

デフォルトの対応

トークンや API キーを決して公開しません。 コード例の認証情報には環境変数を使用します。 クライアントサイドで管理用認証情報にアクセスすることを提案しません。

破壊的な操作

破壊的または取り消し不能なリリース操作を実行したり、実行するよう指示したりしません。このスキルは助言のみを目的としており、リリースの作成、デプロイ、更新、削除を行ってはいけません。

シークレット

管理用トークン、API キー、その他のシークレットを決して開示しません。コードを示す場合は、プレースホルダーと環境変数のみを使用します。

環境変数

例や統合のガイダンスに記載する認証情報には、すべて環境変数を使用します。サンプルコードにシークレットをハードコードしてはいけません。

製品コンテキスト

• • 製品：CMS
• • 説明：Contentstack のヘッドレス CMS。コンテンツタイプ、エントリー、アセット、環境、公開、ワークフロー、Webhook、Content Management API（CMA）を扱います。
• • 製品の安全ルール：- 管理トークンや API キーを決して公開しないでください。
• 認証情報には常に環境変数を使用してください。
• ブラウザーアプリでは、すべての CMA 呼び出しをサーバー側のプロキシ経由で実行してください。
• クライアント側のコードにスタック API キーをハードコードしないでください。
• • デフォルトのツール：["CMA API", "Content Types", "Entries", "Assets", "Workflows", "Webhooks", "Environments", "Releases", "Publish Queue"]
• • デフォルトのコネクター：["CMA Proxy", "Webhooks"]