From 8e50a6d6d80b4eaa2c9706e195ecb6b241d63dbd Mon Sep 17 00:00:00 2001 From: Chris Bohnert <38424477+bohnertchris@users.noreply.github.com> Date: Tue, 5 Nov 2024 15:08:15 +0100 Subject: [PATCH] docs: Updating release version of archetype for existing projects (#1244) * Updating release version of archetype for existing projects CQDOC-22106 * Update README.md Co-authored-by: Ramon Bisswanger * Integrate suggestions on dispatcher update * The docs guy can't spell apparently --------- Co-authored-by: Ramon Bisswanger --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index f2e0e9ded..f8c3b1739 100644 --- a/README.md +++ b/README.md @@ -142,3 +142,22 @@ In order to update transitive dependencies, please exclude the vulnerable transi 2.7 ``` + +## Updating Existing Projects to the Lastest Archetype Release + +The AEM Project Archetype is a tool to create a minimal, best-practices-based AEM project as a starting point for your website. As a starting point, it is not usually required to update an existing project to the latest release of the archteype. However, **keeping project dependencies up-to-date remains a responsiblity of each individual project.** + +Efforts to update to the latest release of the archetype can be significant depending on the age and complexity of the project. If you have determined that the benfits of an update outweigh the effort, Adobe recommends the following steps. + +1. Compare the release of the archetype initially used for your project with the current release on in GitHub. For example `https://github.com/adobe/aem-project-archetype/compare/aem-project-archetype-46...aem-project-archetype-50` +2, Update the changed dependencies. +3. Update the plugin dependencies +4. Progressively apply the remaining changes as needed. + +Adobe strongly recommends sufficient test coverage (including unit tests, integration tests, and end-to-end tests) to ensure that an update does not introduce unexpected behavior. + +## Updating Immutable Dispatcher Files + +Your local immutable files can be updated by running the `bin/update_maven.sh src/dispatcher` script on your Dispatcher folder, where `src/dispatcher` is your Dispatcher configuration directory. This script also updates any `pom.xml` file in the parent directory so that the maven immutability checks also get updated. + +For further details, please see the document [Validating and Debugging using Dispatcher Tools](https://experienceleague.adobe.com/en/docs/experience-manager-cloud-service/content/implementing/content-delivery/validation-debug#third-phase) in the AEM as a Cloud Service documentation.