From 62e7ed21a9f5c77ba79cd39fa4aec725826a5206 Mon Sep 17 00:00:00 2001
From: Chris Bohnert <38424477+bohnertchris@users.noreply.github.com>
Date: Thu, 24 Oct 2024 08:28:13 +0200
Subject: [PATCH 1/4] Updating release version of archetype for existing
projects
CQDOC-22106
---
README.md | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/README.md b/README.md
index 4a146889b..e8acc75ee 100644
--- a/README.md
+++ b/README.md
@@ -142,3 +142,16 @@ 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 signifficant 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 coverate (including unit tests, integration tests, and end-to-end tests) to ensure that an update does not introduce unexpected behavior.
From 6e5406821c94ecf2790168dc50936780e14f8c83 Mon Sep 17 00:00:00 2001
From: Chris Bohnert <38424477+bohnertchris@users.noreply.github.com>
Date: Thu, 31 Oct 2024 13:12:19 +0100
Subject: [PATCH 2/4] Update README.md
Co-authored-by: Ramon Bisswanger
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index e8acc75ee..a191cba1e 100644
--- a/README.md
+++ b/README.md
@@ -154,4 +154,4 @@ Efforts to update to the latest release of the archetype can be signifficant dep
3. Update the plugin dependencies
4. Progressively apply the remaining changes as needed.
-Adobe strongly recommends sufficient test coverate (including unit tests, integration tests, and end-to-end tests) to ensure that an update does not introduce unexpected behavior.
+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.
From ee5a710e498ec52d288d19f76f6c3e9e30a02e9c Mon Sep 17 00:00:00 2001
From: Chris Bohnert <38424477+bohnertchris@users.noreply.github.com>
Date: Thu, 31 Oct 2024 13:19:47 +0100
Subject: [PATCH 3/4] Integrate suggestions on dispatcher update
---
README.md | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/README.md b/README.md
index a191cba1e..9ade90a17 100644
--- a/README.md
+++ b/README.md
@@ -155,3 +155,9 @@ Efforts to update to the latest release of the archetype can be signifficant dep
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 doucment [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.
From b85f49babbae4c4da0910831c8f1e1c48985132f Mon Sep 17 00:00:00 2001
From: Chris Bohnert <38424477+bohnertchris@users.noreply.github.com>
Date: Thu, 31 Oct 2024 14:26:58 +0100
Subject: [PATCH 4/4] The docs guy can't spell apparently
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 9ade90a17..8c27efca2 100644
--- a/README.md
+++ b/README.md
@@ -147,7 +147,7 @@ In order to update transitive dependencies, please exclude the vulnerable transi
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 signifficant 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.
+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.
@@ -160,4 +160,4 @@ Adobe strongly recommends sufficient test coverage (including unit tests, integr
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 doucment [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.
+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.