Extension metadata
quarkus-extension.yaml
This file contains metadata used by Quarkus project generator https://code.quarkus.io/. It is located in the src/main/resources/META-INF directory of the runtime module. Here is an example from the ActiveMQ extension:
name: "Camel ActiveMQ"
description: "Send messages to (or consume from) Apache ActiveMQ 5.x. This component extends the Camel JMS component"
metadata:
icon-url: "https://raw.githubusercontent.com/apache/camel-website/main/antora-ui-camel/src/img/logo-d.svg"
sponsor: "Apache Software Foundation"
guide: "https://camel.apache.org/camel-quarkus/latest/reference/extensions/activemq.html"
categories:
- "integration"
status: "stable"
integrates:
- name: "Camel"
artifact: "org.apache.camel:camel-base"
version: "${camel.version}" Within Camel Quarkus, these files are 100% generated by cq-maven-plugin. To re-generate the quarkus-extension.yaml files in the whole source tree, run the following command from the root directory of the source tree:
mvn -N cq:update-quarkus-metadata The data comes from the following sources:
-
name: comes frompom.xml’s `<name> -
description: taken from Camel Catalog. If the given extension contains more than one component, language or data format, their descriptions are concatenated and a warning is issued in the log. The description is synced to the<description>of the runtime module’spom.xml. To use a custom description instead, set<cq.descriptionSync>false</cq.descriptionSync>together with an explicit<description>in the runtime module’spom.xml. See Extension documentation. -
guide: derived from the extension’sartifactId -
unlisted:trueif the given extension is JVM only, or if the<quarkus.metadata.unlisted>property is set totruein the runtime module’spom.xml; omitted otherwise. -
status: the<quarkus.metadata.status>property in the runtime module’spom.xml. Defaults tostablefor native-supported extensions orpreviewfor JVM-only extensions. -
keywords: omitted unless<quarkus.metadata.keywords>property is available in the runtime module’spom.xmlfile. Please set explicit keywords only if the given term is both important and occurs neither in extension name nor in the description. -
categories: constant