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.

Sign up for GitHub

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 metadata #45

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

add osgi metadata #45

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
258f689
add osgi metadata
zspitzer Jan 19, 2025
352a6a2
downgrade maven-bundle-plugin to 5.1.9 as 6 requires java 17
zspitzer Jan 19, 2025
cf781b2
fix formatting
zspitzer Jan 22, 2025
aecb9ac
Update pom.xml
robinst Mar 27, 2025
44e7828
Update pom.xml
robinst Mar 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,42 @@
</dependencies>

<build>
<pluginManagement>
<plugins>
<plugin>
<artifactId>maven-jar-plugin</artifactId>
<configuration>
<archive>
<manifestFile>${project.build.outputDirectory}/META-INF/MANIFEST.MF</manifestFile>
</archive>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
<version>5.1.9</version>
<configuration>
<instructions>
<Import-Package>
!java
</Import-Package>
<Export-Package>
{local-packages}
</Export-Package>
</instructions>
</configuration>
<executions>
<execution>
<id>bundle-manifest</id>
<phase>process-classes</phase>
<goals>
<goal>manifest</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</pluginManagement>
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The official guide seems to recommend a different approach:

https://felix.apache.org/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.html#_adding_osgi_metadata_to_existing_projects_without_changing_the_packaging_type

Where does your approach come from, and what is the difference?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried the standard approach and it was adding to many exports to the MANIFEST, feel free to try it out locally

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant these bits:

                        <supportedProjectTypes>
                            <supportedProjectType>jar</supportedProjectType>
                            <supportedProjectType>bundle</supportedProjectType>
                        </supportedProjectTypes>
...
                    <executions>
                        <execution>
                            <id>manifest</id>
                            <goals>
                                <goal>manifest</goal>
                            </goals>
                            <configuration>
                                <supportIncrementalBuild>true</supportIncrementalBuild>
                            </configuration>
                        </execution>
                        <execution>
                            <id>bundle</id>
                            <goals>
                                <goal>bundle</goal>
                            </goals>
                        </execution>
                    </executions>

I've pushed commits to the branch to follow the linked instructions above, and it still produces the same end result. Note that before, it looks like it built the jar file twice:

[INFO] --- jar:3.4.1:jar (default-jar) @ autolink ---
[INFO] Building jar: /Users/robinst/private/autolink-java/target/autolink-0.11.1-SNAPSHOT.jar
[INFO]
[INFO] --- bundle:5.1.9:bundle (bundle) @ autolink ---
[INFO] Building bundle: /Users/robinst/private/autolink-java/target/autolink-0.11.1-SNAPSHOT.jar
[INFO] Writing manifest: /Users/robinst/private/autolink-java/target/classes/META-INF/MANIFEST.MF
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS

After:

[INFO] --- jar:3.4.1:jar (default-jar) @ autolink ---
[INFO] Building jar: /Users/robinst/private/autolink-java/target/autolink-0.11.1-SNAPSHOT.jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zspitzer Let me know if that works for you, and happy to proceed with this.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zspitzer Ping?

<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
Expand Down Expand Up @@ -105,6 +141,10 @@
<goals>deploy</goals>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
</plugin>
</plugins>
</build>

Expand Down