Updating the Sling Parent POM

When to use

Use when the user asks to upgrade the Sling parent POM version in their project.

Instructions

• record the current Java and Maven environment with java -version and mvn -version
• run a baseline mvn clean verify if the current checkout is expected to support the current Java version
  • if the baseline build fails only because the current parent POM or project setup requires an older Java version, document that and continue
  • assume the unchanged project would pass with its required Java version; do not switch to version-specific Maven wrappers just to prove the baseline unless the user explicitly asks
  • if the baseline fails for a reason unrelated to the Java version, abort execution and inform the user of the root cause before changing the parent POM
• check if any known workarounds exist, but do not remove them yet
• identify the current version of the Sling parent POM in the user's project
• determine the latest available Sling parent POM version for the applicable parent artifact
  • target the latest available version, not merely the next increment
• update the parent POM version
• run mvn validate with the current Java version before running a full build
  • if mvn validate fails, fix any POM syntax issues first
  • if the new parent POM no longer manages some plugin versions, add explicit plugin versions for the affected plugins
  • if the new parent POM no longer manages some dependency versions, add explicit dependency versions for the affected dependencies
  • do not continue to clean verify until mvn validate succeeds
• run a full mvn clean verify build with the current Java version
  • the goal is for the upgraded project to build successfully with the current Java version
  • if the build fails because Spotless formatting checks were introduced or changed by the new parent POM, run mvn spotless:apply, review the resulting formatting changes, and rerun mvn clean verify
• apply additional verification steps as needed if the specific version requires it
• if workarounds were present before updating the parent POM version, check if they can be removed. If they are needed add them back

Do not touch the git repository state - no staging/unstaging, no commits, no pushes.

Unsupported versions

The following historical versions are not supported and must be skipped:

• 42
• 50

Additional fixes

Use the following reference files when a matching migration issue or build failure appears.

• rat-disable: rat-disable.md
• osgi-r6: osgi-r6.md
• servlet-3: servlet-3.md
• osgi-annotations: osgi-annotations.md
• bundle-parent: bundle-parent.md
• timestamp: timestamp.md
• mockito-java17: mockito-java17.md
• readd-scr-annotations: readd-scr-annotations.md
• osgi-deps: osgi-deps.md
• deps-scope: deps-scope.md

Workarounds

• rat-enable: rat-enable.md