Skip to content

Commit 8e50a6d

Browse files
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 <[email protected]> * Integrate suggestions on dispatcher update * The docs guy can't spell apparently --------- Co-authored-by: Ramon Bisswanger <[email protected]>
1 parent 107d544 commit 8e50a6d

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,3 +142,22 @@ In order to update transitive dependencies, please exclude the vulnerable transi
142142
<version>2.7</version>
143143
</dependency>
144144
```
145+
146+
## Updating Existing Projects to the Lastest Archetype Release
147+
148+
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.**
149+
150+
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.
151+
152+
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`
153+
2, Update the changed dependencies.
154+
3. Update the plugin dependencies
155+
4. Progressively apply the remaining changes as needed.
156+
157+
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.
158+
159+
## Updating Immutable Dispatcher Files
160+
161+
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.
162+
163+
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.

0 commit comments

Comments
 (0)