XM Cloudでのデプロイ後のパブリッシュにおけるベストプラクティス


解説

この記事では、XM Cloud Deployアプリケーションを用いてポストデプロイ(デプロイ後) アクションとしてコンテンツのパブリッシュを行う際のベストプラクティスについて記載します。

ポストデプロイ アクションはxmcloud.build.jsonファイルに定義されている順番に実行され、最後にpublishアクションが実行されます。xmcloud.build.jsonファイルでは、publishアクションは一つだけサポートされています。複数のpublishアクション ノードが構成されている場合、最後の一つだけが処理されます。構成ミスを防ぐため、publishアクションは一つだけ使用するようにしてください。

publishアクションのpathプロパティは単一の値しかサポートしていないため、複数のアイテムをパブリッシュする必要がある場合は、itemIdsプロパティを使用する必要があります。

例:

"publish": {
  "path": "",
  "languages": [ "en", "fr-CA"],
  "itemIds": ["ID1", "ID2", "ID3", "ID4"],
  "targets": ["Edge"],
  "republish": true,
  "publishSubItems": true
}

上記の構成の例は、指定されている言語の複数のアイテムがサブアイテムとともにEdgeパブリッシュ ターゲットにパブリッシュされるという意味になります。

構成にpathitemIdsの両方を指定する場合、itemIdsプロパティのみが考慮され、pathプロパティの値は無視されます。この場合、itemIdsプロパティ配下に定義されたアイテムのみがパブリッシュされることとなります。

ポストデプロイpublishアクションはContent EditorおよびExperience Editorの基本的なパブリッシュ機能と比べて制限があり、関連アイテムのパブリッシュ(Publish related items)オプションが構成でサポートされていません。そのため、以下の代替オプションのいずれかの利用を検討してください。

ポストデプロイ パブリッシュで問題が発生した場合は、アクション後の処理に関する詳細が出力されるデプロイ ログを確認してください。デプロイ ログとパブリッシュ ログを組み合わせて使用することによって、パブリッシュ処理の全体像を把握することができます。