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

Jump to bottom

Don't expose jboss-logging-annotations #45761

Open
lrozenblyum opened this issue Jan 21, 2025 · 5 comments · May be fixed by #46681
Open

Don't expose jboss-logging-annotations #45761

lrozenblyum opened this issue Jan 21, 2025 · 5 comments · May be fixed by #46681
Labels
area/logging good first issue Good for newcomers kind/enhancement New feature or request

Comments

@lrozenblyum
Copy link

Description

Currently quarkus-core exposes transitive dependency on jboss-logging-annotations to other projects (due to usage of the default compile scope).

  1. According to the official doc https://jboss-logging.github.io/jboss-logging-tools/ it should be provided
  2. Currently it causes inconvenience: for example users of keycloak-services 26.1.0 which depends on quarkus-core:3.15.2 which brings jboss-logging-annotations:3.0.1.Final that causes compilation errors (most likely due to the bug: The annotation module should have a runtime dependency on jboss-logging jboss-logging/jboss-logging-tools#127). A workaround exists to set the dependency management for jboss-logging-annotations to 3.0.3.Final.

Yet it seems that it would be better to avoid exposing the jboss-logging-annotations at all.

Implementation ideas

Declare jboss-logging-annotations as provided dependency for quarkus-core
@lrozenblyum lrozenblyum added the kind/enhancement New feature or request label Jan 21, 2025
@gsmet
Copy link
Member

gsmet commented Jan 21, 2025

@dmlloyd WDYT?

@dmlloyd
Copy link
Member

dmlloyd commented Jan 21, 2025

Agreed, the annotations should be provided (in the dependencyManagement section when possible). Additionally, the jboss-logging-processor should not appear in the dependency list or dependencyManagement. Instead it should be given as an argument to annotationProcessorPaths in the configuration of the base maven-compiler-plugin execution (like this example in jboss-threads) in any module which uses it.

@IvanPetkov23
Copy link
Contributor

IvanPetkov23 commented Jan 29, 2025 •
edited
Loading

Is this the only place where annotations are listed in the dependency list?

quarkus/core/runtime/pom.xml

Lines 64 to 67 in 2376041

<dependency>
<groupId>org.jboss.logging</groupId>
<artifactId>jboss-logging-annotations</artifactId>
</dependency>

Also, I can't find jboss-logging-processor in the core module. Thanks :)

@gsmet
Copy link
Member

gsmet commented Jan 29, 2025

@IvanPetkov23 I think it's a good start, but then I would update a standard Quarkus app to io.quarkus:quarkus-bom:999-SNAPSHOT once you deployed this change locally and check the mvn dependency:tree.

@IvanPetkov23
Copy link
Contributor

I ran the changes and checked the dependency tree. The annotations aren't exposed in the dependencies tree. Isn't that the idea of the change? 🙂

@YassineHaouzane YassineHaouzane linked a pull request Mar 9, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/logging good first issue Good for newcomers kind/enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Use provided scope for jboss-logging-annotations dependency YassineHaouzane/quarkus
5 participants
@dmlloyd @gsmet @lrozenblyum @geoand @IvanPetkov23