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

Uber-Jar file name suffix issue for disabling it #45204

Closed
jjpinto opened this issue Dec 19, 2024 · 9 comments · May be fixed by #45205
Closed

Uber-Jar file name suffix issue for disabling it #45204

jjpinto opened this issue Dec 19, 2024 · 9 comments · May be fixed by #45205
Labels
area/documentation kind/bug Something isn't working

Comments

@jjpinto
Copy link

jjpinto commented Dec 19, 2024

Describe the bug

There is a problem regarding the configuration for disabling the runner suffix in the generated uber JAR file in Quarkus documentation.

The documentation states:

"By default the generated uber JAR file name will have the -runner suffix, unless it was overridden by configuring a custom one with quarkus.package.runner-suffix configuration option. If the runner suffix is not desired, it can be disabled by setting quarkus.package.jar.add-runner-suffix configuration option to false, in which case the uber JAR will replace the original JAR file generated by maven-jar-plugin for the application module."

However, the correct configuration option is <quarkus.package.add-runner-suffix>false</quarkus.package.add-runner-suffix>. The quarkus.package.jar.add-runner-suffix option does not work as described.

There is an issue in the Quarkus documentation

Expected behavior

Documentation needs to be updated.
<quarkus.package.add-runner-suffix>false</quarkus.package.add-runner-suffix>

Actual behavior

Follow the documentation to disable the runner suffix using quarkus.package.jar.add-runner-suffix=false.
Build the project and observe that the runner suffix is still present in the uber JAR file name.

How to Reproduce?

mvn clean package

Output of uname -a or ver

Linux L91PLPG3 5.10.16.3-microsoft-standard-WSL2 #1 SMP Fri Apr 2 22:23:49 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux

Output of java -version

openjdk version "22.0.1" 2024-04-16

Quarkus version or git rev

3.16.1

Build tool (ie. output of mvnw --version or gradlew --version)

Apache Maven 3.9.5 (57804ffe001d7215b5e7bcb531cf83df38f93546)

Additional information

No response

@jjpinto jjpinto added the kind/bug Something isn't working label Dec 19, 2024
@geoand
Copy link
Contributor

geoand commented Dec 19, 2024

Would you like to add a PR with the change you propose?

@jjpinto
Copy link
Author

jjpinto commented Dec 19, 2024

Would you like to add a PR with the change you propose?

Ok, will do that.

@geoand
Copy link
Contributor

geoand commented Dec 19, 2024

🙏🏽

@jjpinto
Copy link
Author

jjpinto commented Dec 19, 2024

Added: #45205

@jedla97
Copy link
Contributor

jedla97 commented Dec 19, 2024

Isn't problem somewhere else? The https://quarkus.io/guides/all-config have only quarkus.package.jar.add-runner-suffix property and we have test for it in integration tests PackageIT.java#L218

Maybe https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/configuration/ConfigCompatibility.java#L402 ?

Edit:

It was renamed https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.10#packaging-configuration-gear-white_check_mark so the quarkus.package.jar.add-runner-suffix should work

@geoand
Copy link
Contributor

geoand commented Dec 19, 2024

Oops, I totally flipped the existing and proposed state in my head

@jjpinto
Copy link
Author

jjpinto commented Dec 19, 2024

It makes sense now! Thanks @jedla97

@gsmet
Copy link
Member

gsmet commented Dec 20, 2024

@jjpinto so what's the status of this? Because your change was motivated by something not working. Could you come up with a reproducer? Also, maybe try with 3.17.5.

@jjpinto
Copy link
Author

jjpinto commented Dec 20, 2024

@gsmet the issue was created because the uber-jar parameter wasn't working. I later found out that the parameter had a new path added in Quarkus 3.10+, but not in earlier versions. @jedla97 provided documentation stating the changes, so the .jar was included, and the issue is now closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation kind/bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants