Fix OSGi Export-Package for shaded Guava packages#1690
Closed
kevinherron wants to merge 1 commit intomainfrom
Closed
Fix OSGi Export-Package for shaded Guava packages#1690kevinherron wants to merge 1 commit intomainfrom
kevinherron wants to merge 1 commit intomainfrom
Conversation
Add _exportcontents instruction to stack-core's maven-bundle-plugin configuration to export org.eclipse.milo.shaded.com.google.common.* packages. The maven-bundle-plugin runs before maven-shade-plugin, so it doesn't see the relocated packages. Using _exportcontents allows declaring exports for packages that will be created by shading.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What problem(s) was I solving?
Fixes #1688 - OSGi bundle deployment fails with constraint violations due to mismatched package imports/exports for shaded Guava packages.
When deploying Milo as an OSGi bundle,
sdk-clientdeclares an import fororg.eclipse.milo.shaded.com.google.common.collect, butstack-coreonly exportscom.google.common.collect(the unshaded name). This happens becausemaven-bundle-plugingenerates the MANIFEST.MF in theprocess-classesphase, beforemaven-shade-pluginrelocates the Guava packages in thepackagephase.What user-facing changes did I ship?
OSGi deployments of Milo should now work correctly without constraint violations for the shaded Guava packages.
How I implemented it
Added explicit
maven-bundle-pluginconfiguration instack-core/pom.xmlusing the_exportcontentsBND instruction. This instruction adds packages to the OSGiExport-Packagemanifest header without requiring the packages to exist at analysis time, allowingstack-coreto declare exports for the shaded packages thatmaven-shade-plugincreates later in the build lifecycle.How to verify it
Manual Testing
mvn clean packagestack-core's MANIFEST.MF to verify it now includesExport-Packageentries fororg.eclipse.milo.shaded.com.google.common.*Description for the changelog
Fixed OSGi Export-Package manifest to include shaded Guava packages, resolving bundle deployment constraint violations.