Store since JavaDoc tag in the configuration metadata, so that Quarkiverse projects can render it in their documentation if they like

[ppalaga]

quarkiverse/antora-ui-quarkiverse#64

[michalvavrik]

Part that I don't understand about this is that config properties are versioned and documentation is branched. So if user needs to know whether his Quarkus version supports the config property, he just needs to read documentation for his Quarkus version. Also such hardcoded statement "supported since" doesn't take into consideration backports.

[ppalaga]

Thanks for the feedback, @michalvavrik !

Part that I don't understand about this is that config properties are versioned and documentation is branched. So if user needs to know whether his Quarkus version supports the config property, he just needs to read documentation for his Quarkus version.

Yeah, that's something we know well as Quarkus developers, however end users may not notice this every time. They just read the version of the docs that Google shows them.

Another point is that Quarkiverse projects may have various awkward policies regarding which docs branches are published at all and for how long. E.g. Camel Quarkus and Quarkus CXF both publish only dev and some recent LTS branches.
Camel Quarkus LTS branches that are end of life are removed from the site.

Hence it is e.g. impossible to figure out whether an option documented in the dev branch is actually available in the last release at all.

Also such hardcoded statement "supported since" doesn't take into consideration backports.

New config options are new features, that should typically not be backported. If it happens for some reason, the since tag could perhaps have a different value in the LTS branch where the new option is backported.

[michalvavrik]

Alright @ppalaga , makes sense.

New config options are new features, that should typically not be backported.

Agreed, but I just know it happens from time to time, this is the latest I remember: #37269

If it happens for some reason, the since tag could perhaps have a different value in the LTS branch where the new option is backported.

ok

[ppalaga]

In case there is enough agreement that we want to have the since tag rendered, I'd still be thankful for any comments from our UI experts about how to present the tag in the docs. I am not especially keen on the current working version that looks like the following

[michalvavrik]

In case there is enough agreement that we want to have the since tag rendered, I'd still be thankful for any comments from our UI experts about how to present the tag in the docs

I think @machi1990 and @gsmet are ones who wrote docs generation, maybe they can help you.

[maxandersen]

Nice improvement Peter - I think this is good info to get in.
One issue though - which version is it referring to - its the individual extension version which might not be easily to locate in all places this is shown.

[maxandersen]

@holly-cummins this is another example of core vs platform vs individual extensions - the "since" part all depends on your perception.

I would probably put it below the key - or even below description now thinking that version can be misleading - maybe the generation and include GAV info ?

[ppalaga]

I would probably put it below the key - or even below description now thinking that version can be misleading

I'd be fine with both, slightly prefering below the key.

Note that we might want to show also @deprecated around there.

• maybe the generation

You mean just major.minor instead of major.minor.micro? I'd be for full, bc. we already had options introduced in micros to fix issues.

and include GAV info ?

You mean like Since Quarkus CXF 1.2.3?

[ppalaga]

I changed the scope from "Render in the docs" to "Store in the configuration metadata, so that
Quarkiverse projects can render it in their documentation if they like".
There will be no observable effect on Quarkus docs and I get some freedom to experiment in Quarkus CXF.

It would be nice if this could be backported to 3.8

[quarkus-bot]

Status for workflow Quarkus CI

This is the status report for running Quarkus CI on commit 7353593.

Failing Jobs

Status	Name	Step	Failures	Logs	Raw logs	Build scan
✖	Native Tests - Data1	Build	Failures	Logs	Raw logs	🚧

Full information is available in the Build summary check run.

Failures

⚙️ Native Tests - Data1 #

- Failing: integration-tests/hibernate-orm-tenancy/connection-resolver 

📦 integration-tests/hibernate-orm-tenancy/connection-resolver

✖ io.quarkus.it.hibernate.multitenancy.fruit.HibernateTenancyFunctionalityInGraalITCase.testAddDeleteDefaultTenant - History - More details - Source on GitHub

java.lang.AssertionError: 
1 expectation failed.
Expected status code is <201> but was <500>.

	at java.base/java.lang.reflect.Constructor.newInstanceWithCaller(Constructor.java:499)
	at java.base/java.lang.reflect.Constructor.newInstance(Constructor.java:480)
	at org.codehaus.groovy.reflection.CachedConstructor.invoke(CachedConstructor.java:73)
	at org.codehaus.groovy.runtime.callsite.ConstructorSite$ConstructorSiteNoUnwrapNoCoerce.callConstructor(ConstructorSite.java:108)

✖ io.quarkus.it.hibernate.multitenancy.fruit.HibernateTenancyFunctionalityInGraalITCase.testGetFruitsDefaultTenant - History - More details - Source on GitHub

java.lang.AssertionError: 
1 expectation failed.
Expected status code is <200> but was <500>.

	at java.base/java.lang.reflect.Constructor.newInstanceWithCaller(Constructor.java:499)
	at java.base/java.lang.reflect.Constructor.newInstance(Constructor.java:480)
	at org.codehaus.groovy.reflection.CachedConstructor.invoke(CachedConstructor.java:73)
	at org.codehaus.groovy.runtime.callsite.ConstructorSite$ConstructorSiteNoUnwrapNoCoerce.callConstructor(ConstructorSite.java:108)

✖ io.quarkus.it.hibernate.multitenancy.fruit.HibernateTenancyFunctionalityInGraalITCase.testGetFruitsTenantMycompany - History - More details - Source on GitHub

java.lang.AssertionError: 
1 expectation failed.
Expected status code is <200> but was <500>.

	at java.base/java.lang.reflect.Constructor.newInstanceWithCaller(Constructor.java:499)
	at java.base/java.lang.reflect.Constructor.newInstance(Constructor.java:480)
	at org.codehaus.groovy.reflection.CachedConstructor.invoke(CachedConstructor.java:73)
	at org.codehaus.groovy.runtime.callsite.ConstructorSite$ConstructorSiteNoUnwrapNoCoerce.callConstructor(ConstructorSite.java:108)

✖ io.quarkus.it.hibernate.multitenancy.fruit.HibernateTenancyFunctionalityInGraalITCase.testPostFruitDefaultTenant - History - More details - Source on GitHub

java.lang.AssertionError: 
1 expectation failed.
Expected status code is <201> but was <500>.

	at java.base/java.lang.reflect.Constructor.newInstanceWithCaller(Constructor.java:499)
	at java.base/java.lang.reflect.Constructor.newInstance(Constructor.java:480)
	at org.codehaus.groovy.reflection.CachedConstructor.invoke(CachedConstructor.java:73)
	at org.codehaus.groovy.runtime.callsite.ConstructorSite$ConstructorSiteNoUnwrapNoCoerce.callConstructor(ConstructorSite.java:108)

✖ io.quarkus.it.hibernate.multitenancy.fruit.HibernateTenancyFunctionalityInGraalITCase.testUpdateFruitDefaultTenant - History - More details - Source on GitHub

java.lang.AssertionError: 
1 expectation failed.
Expected status code is <201> but was <500>.

	at java.base/java.lang.reflect.Constructor.newInstanceWithCaller(Constructor.java:499)
	at java.base/java.lang.reflect.Constructor.newInstance(Constructor.java:480)
	at org.codehaus.groovy.reflection.CachedConstructor.invoke(CachedConstructor.java:73)
	at org.codehaus.groovy.runtime.callsite.ConstructorSite$ConstructorSiteNoUnwrapNoCoerce.callConstructor(ConstructorSite.java:108)

---

Flaky tests - Develocity

⚙️ JVM Tests - JDK 17

📦 extensions/smallrye-reactive-messaging-kafka/deployment

✖ io.quarkus.smallrye.reactivemessaging.kafka.deployment.dev.KafkaDevServicesDevModeTestCase.sseStream - History

• Assertion condition defined as a io.quarkus.smallrye.reactivemessaging.kafka.deployment.dev.KafkaDevServicesDevModeTestCase Expecting size of: [] to be greater than or equal to 2 but was 0 within 10 seconds. - org.awaitility.core.ConditionTimeoutException

org.awaitility.core.ConditionTimeoutException: 
Assertion condition defined as a io.quarkus.smallrye.reactivemessaging.kafka.deployment.dev.KafkaDevServicesDevModeTestCase 
Expecting size of:
  []
to be greater than or equal to 2 but was 0 within 10 seconds.
	at org.awaitility.core.ConditionAwaiter.await(ConditionAwaiter.java:167)
	at org.awaitility.core.AssertionCondition.await(AssertionCondition.java:119)
	at org.awaitility.core.AssertionCondition.await(AssertionCondition.java:31)

📦 integration-tests/jpa-oracle

✖ io.quarkus.it.jpa.oracle.JPAFunctionalityTest.testLdapFromServlet - History

• 1 expectation failed. Response body doesn't match expectation. Expected: is "OK" Actual: {"details":"Error id 6624f012-11eb-43ee-8cea-9c44beef7bbf-1, java.sql.SQLException: Acquisition timeout while waiting for new connection","stack":"java.sql.SQLException: Acquisition timeout while waiting for new connection\n\tat io.agroal.pool.ConnectionPool.handlerFromSharedCache(ConnectionPool.java:321)\n\tat io.agroal.pool.ConnectionPool.getConnection(ConnectionPool.java:249)\n\tat io.agroal.pool.DataSource.getConnection(DataSource.java:86)\n\tat io.agroal.api.AgroalDataSource_ARxsrSf_4rhY8Cw6l4pmWY5nZY4_Synthetic_ClientProxy.getConnection(Unknown Source)\n\tat io.quarkus.example.jpaoracle.LdapUrlTestEndpoint.test(LdapUrlTestEndpoint.java:29)\n\tat io.quarkus.example.jpaoracle.LdapUrlTestEndpoint$quarkusrestinvoker$test_056288de5192b9be1916ebef3bf0275a7088b428.invoke(Unknown Source)\n\tat org.jboss.resteasy.reactive.server.handlers.InvocationHandler.handle(InvocationHandler.java:29)\n\tat io.quarkus.resteasy.reactive.server.runtime.QuarkusResteasyReactiveRequestContext.invokeHandler(QuarkusResteasyReactiveRequestContext.java:141)\n\tat org.jboss.resteasy.reactive.common.core.AbstractResteasyReactiveContext.run(AbstractResteasyReactiveContext.java:147)\n\tat io.quarkus.vertx.core.runtime.VertxCoreRecorder$14.runWith(VertxCoreRecorder.java:599)\n\tat org.jboss.threads.EnhancedQueueExecutor$Task.run(EnhancedQueueExecutor.java:2513)\n\tat org.jboss.threads.EnhancedQueueExecutor$ThreadBody.run(EnhancedQueueExecutor.java:1538)\n\tat org.jboss.threads.DelegatingRunnable.run(DelegatingRunnable.java:29)\n\tat org.jboss.threads.ThreadLocalResettingRunnable.run(ThreadLocalResettingRunnable.java:29)\n\tat io.netty.util.concurrent.FastThreadLocalRunnable.run(FastThreadLocalRunnable.java:30)\n\tat java.base/java.lang.Thread.run(Thread.java:840)\nCaused by: java.util.concurrent.TimeoutException\n\tat java.base/java.util.concurrent.FutureTask.get(FutureTask.java:204)\n\tat io.agroal.pool.ConnectionPool.handlerFromSharedCache(ConnectionPool.java:298)\n\t... 15 more"} - java.lang.AssertionError

java.lang.AssertionError: 
1 expectation failed.
Response body doesn't match expectation.
Expected: is "OK"
  Actual: {"details":"Error id 6624f012-11eb-43ee-8cea-9c44beef7bbf-1, java.sql.SQLException: Acquisition timeout while waiting for new connection","stack":"java.sql.SQLException: Acquisition timeout while waiting for new connection\n\tat io.agroal.pool.ConnectionPool.handlerFromSharedCache(ConnectionPool.java:321)\n\tat io.agroal.pool.ConnectionPool.getConnection(ConnectionPool.java:249)\n\tat io.agroal.pool.DataSource.getConnection(DataSource.java:86)\n\tat io.agroal.api.AgroalDataSource_ARxsrSf_4rhY8Cw6l4pmWY5nZY4_Synthetic_ClientProxy.getConnection(Unknown Source)\n\tat io.quarkus.example.jpaoracle.LdapUrlTestEndpoint.test(LdapUrlTestEndpoint.java:29)\n\tat io.quarkus.example.jpaoracle.LdapUrlTestEndpoint$quarkusrestinvoker$test_056288de5192b9be1916ebef3bf0275a7088b428.invoke(Unknown Source)\n\tat org.jboss.resteasy.reactive.server.handlers.InvocationHandler.handle(Invocat...

[ppalaga]

The test failures do not seem to be related.

Any feedback on this?

[gsmet]

Tested locally and it seems to not disturb our doc so let's merge.

[ppalaga]

Perfect, thanks @gsmet !