Skip to content

Commit e266e81

Browse files
authored
Merge pull request #5805 from loicmathieu/fix/extension-author-guide
Fixes the extension author guide WRT the new quarkus-extension.yaml
2 parents a2f6602 + 0d70aa2 commit e266e81

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

docs/src/main/asciidoc/writing-extensions.adoc

100644100755
Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,24 @@ The above sequence of commands does the following:
378378
A Maven build performed immediately after generating the modules should fail due to a `fail()` assertion in one of the test classes.
379379

380380
There is one step (specific to the Quarkus source tree) that you should do manually when creating a new extension:
381-
Add the extension coordinates to `devtools/common/src/main/filtered/extensions.json`.
381+
create a `quarkus-extension.yaml` file that describe your extension inside the runtime module `src/main/resources/META-INF` folder.
382+
383+
This is the `quarkus-extension.yaml` of the `quarkus-agroal` extension, you can use it as an example:
384+
385+
[source,yaml]
386+
----
387+
name: "Agroal - Database connection pool"
388+
metadata:
389+
keywords:
390+
- "agroal"
391+
- "database-connection-pool"
392+
- "datasource"
393+
- "jdbc"
394+
guide: "https://quarkus.io/guides/datasource"
395+
categories:
396+
- "data"
397+
status: "stable"
398+
----
382399

383400
Note that the parameters of the mojo that will be constant for all the extensions added to this source tree are configured in `extensions/pom.xml` so that they do not need to be passed on the command line each time a new extension is added:
384401

0 commit comments

Comments
 (0)