Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add OSGi manifest headers to JARs #12099

Open
bdhoine opened this issue Aug 23, 2024 · 2 comments
Open

Add OSGi manifest headers to JARs #12099

bdhoine opened this issue Aug 23, 2024 · 2 comments
Labels
contribution welcome Request makes sense, maintainers probably won't have time, contribution would be welcome enhancement New feature or request

Comments

@bdhoine
Copy link

bdhoine commented Aug 23, 2024

Is your feature request related to a problem? Please describe.

The current build of the opentelemetry-java-instrumentation project lacks the necessary OSGi manifest headers in its generated JAR files. This omission prevents the JARs from being used directly as OSGi bundles. To ensure compatibility and ease of integration with OSGi environments, it is important to include the appropriate OSGi headers in the manifest files of these JARs.

Describe the solution you'd like

Modify the build configuration to automatically include the necessary OSGi headers in the manifest files of all JARs produced by this project.

The following headers should be included in the manifest:

  • Bundle-Name: A human-readable name for the bundle.
  • Bundle-SymbolicName: A unique identifier for the bundle.
  • Bundle-Version: The version of the bundle.
  • Export-Package: The packages to be exported for use by other bundles.
  • Import-Package: The packages required by this bundle from other bundles.

Describe alternatives you've considered

No response

Additional context

Adding these headers would significantly enhance the usability of this library in OSGi-based projects, allowing for seamless integration into environments that rely on modularity and dynamic loading of components. It would also align this project with best practices for Java library distribution in modular systems.

@bdhoine bdhoine added enhancement New feature or request needs triage New issue that requires triage labels Aug 23, 2024
@trask
Copy link
Member

trask commented Aug 26, 2024

hi @bdhoine! do the jars in https://github.com/open-telemetry/opentelemetry-java have these headers? if so, we would be happy if someone copies over the same mechanism for creating those headers to this repo

@trask trask added contribution welcome Request makes sense, maintainers probably won't have time, contribution would be welcome and removed needs triage New issue that requires triage labels Aug 26, 2024
@bdhoine
Copy link
Author

bdhoine commented Aug 28, 2024

@trask this is ongoing work by myself and @royteeuwen, I have a draft pr open in open-telemetry/semantic-conventions-java#87 for example and we are also working on this one open-telemetry/opentelemetry-java#768, when that is completed I will contribute here also

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution welcome Request makes sense, maintainers probably won't have time, contribution would be welcome enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants