Skip to content

Conversation

@wjglerum
Copy link
Contributor

@wjglerum wjglerum commented Nov 18, 2025

Make it possible to use AsciiDoc attributes directly in the ConfigDocDefault annotation. This is especially useful to pass Maven properties as AsciiDoc attributes to the config properties as a default value for the documentation.

For example, we now define the keycloak.docker.image in a central place, however we lost the default value in the documentation. With this change we can also use AsciiDoc attributes as default value again for the documentation.

This should cover the initial idea from @gsmet, see #51024 (comment)

Locally this rendered the default value again for the Keycloak Docker image

image

DEV SERVICES OVERVIEW

@quarkus-bot quarkus-bot bot added area/core area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins labels Nov 18, 2025
@wjglerum wjglerum marked this pull request as ready for review November 18, 2025 20:30
Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks mostly good, thanks a lot. I added a couple of minor comments.

@wjglerum
Copy link
Contributor Author

Looks mostly good, thanks a lot. I added a couple of minor comments.

Thanks! Processed your feedback, if it looks good I can squash the commits

@wjglerum wjglerum force-pushed the config-doc-default-ascii-doc-attribute branch 3 times, most recently from bb41584 to a565a95 Compare November 19, 2025 12:58
@quarkus-bot quarkus-bot bot added area/dependencies Pull requests that update a dependency file area/docstyle issues related for manual docstyle review area/documentation area/reactive-messaging area/smallrye labels Nov 19, 2025
@quarkus-bot

This comment has been minimized.

@github-actions
Copy link

github-actions bot commented Nov 19, 2025

🙈 The PR is closed and the preview is expired.

@quarkus-bot

This comment has been minimized.

Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a few comments.

@gsmet
Copy link
Member

gsmet commented Nov 19, 2025

Also, not sure if you're aware but we can probably also improve things for these (not sure they are all used for Dev Services but at least some of them are):

        <elasticsearch.image>docker.io/elastic/elasticsearch:${elasticsearch-server.version}</elasticsearch.image>
        <logstash.image>docker.io/elastic/logstash:${elasticsearch-server.version}</logstash.image>
        <kibana.image>docker.io/elastic/kibana:${elasticsearch-server.version}</kibana.image>
        <opensearch.image>docker.io/opensearchproject/opensearch:${opensearch-server.version}</opensearch.image>

        <!-- Database images for JDBC/Reactive/Hibernate tests and devservices -->
        <postgres.image>docker.io/postgres:17</postgres.image>
        <mariadb.image>docker.io/mariadb:10.11</mariadb.image>
        <db2.image>icr.io/db2_community/db2:12.1.0.0</db2.image>
        <mssql.image>mcr.microsoft.com/mssql/server:2022-latest</mssql.image>
        <mysql.image>docker.io/mysql:8.4</mysql.image>
        <oracle.image>docker.io/gvenzl/oracle-free:23-slim-faststart</oracle.image>
        <mongo.image>docker.io/mongo:7.0</mongo.image>

@wjglerum wjglerum force-pushed the config-doc-default-ascii-doc-attribute branch from 1934889 to 4915616 Compare November 19, 2025 18:06
@quarkus-bot

This comment has been minimized.

@gsmet gsmet marked this pull request as draft November 19, 2025 18:21
@wjglerum wjglerum force-pushed the config-doc-default-ascii-doc-attribute branch from 4915616 to 80dcb3f Compare November 19, 2025 21:10
@quarkus-bot quarkus-bot bot added the area/infinispan Infinispan label Nov 19, 2025
@wjglerum wjglerum force-pushed the config-doc-default-ascii-doc-attribute branch 2 times, most recently from 624d20b to 133abdf Compare November 20, 2025 17:33
@wjglerum wjglerum changed the title Allow to set default value for config options with AsciiDoc attributes in the docs Allow to set default value for config options with AsciiDoc attributes Nov 20, 2025
Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really cool. I spotted one minor thing but other than that, I think it looks good to go.

@wjglerum wjglerum marked this pull request as ready for review November 20, 2025 18:53
@wjglerum wjglerum requested a review from gsmet November 20, 2025 18:59
@quarkus-bot

This comment has been minimized.

@quarkus-bot

This comment has been minimized.

@quarkus-bot
Copy link

quarkus-bot bot commented Nov 21, 2025

Status for workflow Quarkus Documentation CI

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

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

Warning

There are other workflow runs running, you probably need to wait for their status before merging.

Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome work, thanks a lot!

@gsmet gsmet added triage/backport triage/waiting-for-ci Ready to merge when CI successfully finishes labels Nov 21, 2025
@quarkus-bot

This comment has been minimized.

@quarkus-bot
Copy link

quarkus-bot bot commented Nov 21, 2025

Status for workflow Quarkus CI

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

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

You can consult the Develocity build scans.

@gsmet gsmet merged commit d138192 into quarkusio:main Nov 21, 2025
117 of 118 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.31 - main milestone Nov 21, 2025
@quarkus-bot quarkus-bot bot removed the triage/waiting-for-ci Ready to merge when CI successfully finishes label Nov 21, 2025
@gsmet
Copy link
Member

gsmet commented Nov 21, 2025

And merged. Thanks again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants