Updating release version of archetype for existing projects

[bohnertchris]

Description

Add recommendation that updating the archetype release for existing project is generally not required, along with guidance if a particular project determines that an update is required.

Related Issue

CQDOC-22106

Motivation and Context

This was not explicitly stated before. Also give opportunity to re-emphasize that keeping dependencies up-to-date is the responsibility of the individual project.

How Has This Been Tested?

It hasn't. This is a documentation change only.

Screenshots (if appropriate):

n/a

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation

Checklist:

• I have signed the Adobe Open Source CLA.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.

[kwin]

I think it is worth explicitly mentioning immutable dispatcher files and how to update those.

[krystiannowak]

I think it is worth explicitly mentioning immutable dispatcher files and how to update those.

@kwin There is a script in it https://github.com/adobe/aem-project-archetype/blob/develop/src/main/archetype/dispatcher.cloud/update_sdk.sh for 2 years - since August 2022 via #966 by @froesef - see note in https://github.com/adobe/aem-project-archetype/releases/tag/aem-project-archetype-39
(besides updating the immutable dispatcher config files themselves out of Dispatcher SDK tooling, it also updates the checksums that are generated in one's pom.xml in order for maven-enforcer-plugin to pass with new immutable files after updating)

[kwin]

Perfect, would be nice to mention that in the update section then.

[krystiannowak]

Perfect, would be nice to mention that in the update section then.

@kwin It is mentioned in https://experienceleague.adobe.com/en/docs/experience-manager-cloud-service/content/implementing/content-delivery/validation-debug#third-phase

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.

[krystiannowak]

@kwin FYI Mentioned in Updating archetype dispatcher.cloud configuration to version 2.0.232 by @krystiannowak in #1237 line in https://github.com/adobe/aem-project-archetype/releases/tag/aem-project-archetype-51 refers to the immutable files changes in the newest dispatcher-publish image and present in Dispatcher SDK tooling 2.0.232 related to SKYOPS-77603 : Management of redirects by business users in Enhancements section set in https://experienceleague.adobe.com/en/docs/experience-manager-cloud-service/content/release-notes/maintenance/latest for AEM CS Release 18311

[krystiannowak]

Perfect, would be nice to mention that in the update section then.

@kwin But true

@bohnertchris Would it make sense to also include in the change to mention usage of https://github.com/adobe/aem-project-archetype/blob/develop/src/main/archetype/dispatcher.cloud/update_sdk.sh as suggested in https://experienceleague.adobe.com/en/docs/experience-manager-cloud-service/content/implementing/content-delivery/validation-debug#third-phase last paragraph or rephrase it:

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.

e.g. as point number 5 in the proposed Updating Existing Projects to the Lastest Archetype Release section being added in this PR?

cc: @froesef

[krystiannowak]

+1

[bohnertchris]

@buuhuu would you please review and merge? Thank you.