Adobe Experience Manager as a Cloud Serviceでのaem.js ボイラープレートのアップグレード

この記事では、Adobe Experience Manager as a Cloud Serviceのaem.js ボイラープレートをアップグレードするためのガイダンスを提供し、互換性に関する考慮事項、ワークフローへの影響、推奨されるベストプラクティスを強調します。

説明 description

環境

Adobe Experience Manager as a Cloud Service(すべてのバージョン)、aem.js boilerplate v3.0.0-v3.1.8

問題/症状

  • アップストリームの変更をaem.jsに既存のプロジェクトに組み込みます。
  • 変更を結合する前に、カスタムブロック、スクリプト、プレビューまたは公開に対する効果を確認する必要があります。

原因

AEMの定型文は、スタータープロジェクトです。 アップストリームボイラープレートへの変更は、既存のプロジェクトを自動的に更新するものではありません。開発者は、変更内容を確認し、プロジェクトリポジトリに統合します。 プロジェクト固有の動作は、aem.js以外の拡張機能に属し、ライブラリのローカル修正には属しません。

解決策 resolution

問題を解決するには、次の手順に従います。

  1. バージョン 3.0.0と3.1.8の間のaem.js ボイラープレートで導入された変更を確認します。

  2. 実装でバージョン 3.1.0を使用しているかどうかを確認します。 このリリースでは、セクションメタデータの処理がdecorateSections()から削除された破壊的な変更が導入されました。 この変更は回帰として識別され、バージョン 3.1.1で元に戻されました。

  3. 実装でバージョン 3.1.0を使用している場合は、バージョン 3.1.1以降にアップグレードして、セクションのメタデータ処理を復元します。

  4. バージョン 3.1.1 ~ 3.1.8で導入された変更を確認してください。 これらのリリースには、依存関係の更新や、重複するヘッダーブロックやフッターブロックの解決、コードパス解決の更新などのマイナーな修正が含まれています。

  5. 実装への影響を評価し、変更が公開、プレビュー、またはブロックレンダリングのワークフローに影響しないことを確認します。 バージョン 3.1.0の回帰を除き、これらのワークフローで破損した変更は特定されませんでした。

  6. アップグレードする前に、機能ブランチの変更を検証します。 プレビュー環境を使用するようにブランチを設定し、更新されたコードをプッシュした後に変更を確認します。

  7. 変更を公開する前に、ローカルでテストします。 AEM CLIを使用してコンテンツを取得し、更新を検証します。 次のコマンドを使用すると、公開前に変更内容を確認できます。

    code language-none
    aem content clone
    aem up
    aem content diff
    aem content push --dry-run
    
  8. 変更を結合する前に、メインブランチのブランチ保護ルールを設定し、プルリクエスト、ステータスチェック、最新のブランチを必要とします。 これにより、本番環境に移行する前に、あらゆる変更をプレビュー環境でレビューおよび検証できます。

  9. アップグレード後、ローカル環境とプレビュー環境の両方でカスタムブロックとスクリプトの依存関係を徹底的にテストして、互換性を検証します。

  10. アップグレード後に、公開、プレビュー、ブロックレンダリング、セクションメタデータの処理、カスタムブロック、スクリプトの依存関係が期待どおりに機能することを確認します。

recommendation-more-help
experience-cloud-kcs-help-kbarticles