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

Quarkus Maven Plugin doc parameters are broken #37488

Closed
ia3andy opened this issue Dec 4, 2023 · 3 comments · Fixed by #37920
Closed

Quarkus Maven Plugin doc parameters are broken #37488

ia3andy opened this issue Dec 4, 2023 · 3 comments · Fixed by #37920
Labels
area/maven good first issue Good for newcomers kind/bug Something isn't working
Milestone

Comments

@ia3andy
Copy link
Contributor

ia3andy commented Dec 4, 2023

Describe the bug

Currently it uses the name which is not the actual parameter name as defined in the doc (name is when configuring from the pom.xml), it should use the property instead:

Because of this the doc parameters names a wrong:

We need to make sure the @Parameter(property=... is used in the doc when set (I would hope that the fieldName is used if not set).

Expected behavior

Have the right parameter names in the doc

Actual behavior

it uses the fieldName because name is not the actual name of the property at all, see:
https://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html#name()

@ia3andy ia3andy added the kind/bug Something isn't working label Dec 4, 2023
Copy link

quarkus-bot bot commented Dec 4, 2023

/cc @quarkusio/devtools (maven)

@ia3andy ia3andy added the good first issue Good for newcomers label Dec 4, 2023
@ia3andy
Copy link
Contributor Author

ia3andy commented Dec 5, 2023

ok after a bit of investigation it's not a simple, for some reason Maven didn't provide api to access the property.
Best solution might be to align properties and names (as name is used when configuring the plugin from the pom.xml)
https://stackoverflow.com/a/34659049

@mcruzdev
Copy link
Contributor

@quarkus-bot quarkus-bot bot added this to the 3.9 - main milestone Jan 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/maven good first issue Good for newcomers kind/bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants