-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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 @ConfigItem#generateDocumentation to enable/disable generation of documentation #26126
Conversation
I could not find where to add tests for |
This comment has been minimized.
This comment has been minimized.
I can reproduce the Gradle test failures in my logs, but the cause seems unrelated to my changes:
I'm investigating why in the world we'd be looking for this artifact on the JCenter mirror inside the Gradle Maven repository... |
See #26140 regarding the Gradle failures. They indeed seem unrelated to my changes. |
5844dd9
to
95ec09c
Compare
Failing Jobs - Building 95ec09c
Full information is available in the Build summary check run. Failures⚙️ JVM Tests - JDK 11 #- Failing: extensions/resteasy-reactive/quarkus-resteasy-reactive-jaxb/deployment
! Skipped: extensions/resteasy-reactive/rest-client-reactive-jaxb/deployment integration-tests/hibernate-validator-resteasy-reactive 📦 extensions/resteasy-reactive/quarkus-resteasy-reactive-jaxb/deployment✖
✖
✖
✖
✖
✖
⚙️ JVM Tests - JDK 17 #- Failing: extensions/resteasy-reactive/quarkus-resteasy-reactive-jaxb/deployment integration-tests/grpc-hibernate
! Skipped: extensions/resteasy-reactive/rest-client-reactive-jaxb/deployment integration-tests/hibernate-validator-resteasy-reactive 📦 extensions/resteasy-reactive/quarkus-resteasy-reactive-jaxb/deployment✖
✖
✖
✖
✖
✖
📦 integration-tests/grpc-hibernate✖
|
The failures are not related. |
In order to address #19129, I had to introduce a configuration property in both the build config and runtime config, because the same
Map<String, String>
configuration can affect static init (when building the Hibernate ORM metadata) or runtime init (when building the Hibernate ORM session factory), depending on the keys being used. I don't want to expose two separate configuration properties because that would complicate an already complex (and unsupported) feature.The problem is, documentation is generated for the same configuration property twice: once for the build config, and once for the runtime config. This leads to problems when rendering the asciidoc (duplicate section IDs, in particular).
My solution: annotate the build-time configuration property with
@ConfigItem(generateDocumentation = false)
, so that we generate documentation only for the runtime configuration property. It works 🤷