Skip to content

Commit

Permalink
docs: Updating release version of archetype for existing projects (#1244
Browse files Browse the repository at this point in the history
)

* Updating release version of archetype for existing projects

CQDOC-22106

* Update README.md

Co-authored-by: Ramon Bisswanger <ramon@bisswanger.de>

* Integrate suggestions on dispatcher update

* The docs guy can't spell apparently

---------

Co-authored-by: Ramon Bisswanger <ramon@bisswanger.de>
  • Loading branch information
bohnertchris and bisswanger authored Nov 5, 2024
1 parent 107d544 commit 8e50a6d
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,3 +142,22 @@ In order to update transitive dependencies, please exclude the vulnerable transi
<version>2.7</version>
</dependency>
```

## 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.

0 comments on commit 8e50a6d

Please sign in to comment.