Package Breaking Changes Since DXP Release

If you plan to customize DXP, you should be aware that some of the packages exported by various DXP artifacts experienced version increases after the release. You can use the select boxes below to check if you'll run into problems.

Warning: This is NOT an official Liferay tool, nor is it supported by Liferay in any way. This does a source code analysis of the code that exists at the tag for the specified release. For Marketplace plugins (which are released on a separate schedule), these versions will not be accurate.

Choose Your Comparison

Note: If the values in the select boxes are the same, this will list the versions of all packages at the specified baseline rather than a comparison. You can show only breaking changes using the checkboxes below.

Starting VersionCheck Against VersionName FilterOther Filters

Comparison Results

Note: Entries with a gray background indicate a version change. Version 0.0.0 means that the package does not exist in that version of DXP. You can show only breaking changes using the checkboxes above.

 

About the Comparison

You might be wondering, "What is a breaking change?"

A major version increase in a package caused by a patch means that if you patch your server, your custom module will no longer be active after server restart if it used any of these packages. This can only be addressed by recompiling against an updated artifact that indicates it has the needed export version. Therefore, in all cases, a major version change is treated as a breaking change.

A minor version increase in a package caused by a patch means that if you patch your server and compile against the updated artifact, your customization will not deploy if you then decide to undo the patch. This can only be addressed by recompiling against the older artifact used after the rollback that indicates the needed export version. Therefore, when you are DOWNGRADING Liferay, a minor version change is treated as a breaking change.

Note that it's also possible that an artifact with the manifest you need has not yet been published to Maven, so you may have to manually add the dependency to your local repository by extracting the JAR from the marketplace LPKG in your bundle.

Additional Notes

Additionally, if you used any of the following packages, the bundle that exports that package has changed. This will be relevant if you plan to upgrade the old artifact to a new version, as your code will stop compiling.

Package NameOld Artifact NameNew Artifact Name
com.liferay.contacts.utilcom.liferay.contacts.servicecom.liferay.contacts.api