Skip to content

Commit

Permalink
Merge pull request #5805 from loicmathieu/fix/extension-author-guide
Browse files Browse the repository at this point in the history
Fixes the extension author guide WRT the new quarkus-extension.yaml
  • Loading branch information
gsmet authored Nov 27, 2019
2 parents a2f6602 + 0d70aa2 commit e266e81
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion docs/src/main/asciidoc/writing-extensions.adoc
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,24 @@ The above sequence of commands does the following:
A Maven build performed immediately after generating the modules should fail due to a `fail()` assertion in one of the test classes.

There is one step (specific to the Quarkus source tree) that you should do manually when creating a new extension:
Add the extension coordinates to `devtools/common/src/main/filtered/extensions.json`.
create a `quarkus-extension.yaml` file that describe your extension inside the runtime module `src/main/resources/META-INF` folder.

This is the `quarkus-extension.yaml` of the `quarkus-agroal` extension, you can use it as an example:

[source,yaml]
----
name: "Agroal - Database connection pool"
metadata:
keywords:
- "agroal"
- "database-connection-pool"
- "datasource"
- "jdbc"
guide: "https://quarkus.io/guides/datasource"
categories:
- "data"
status: "stable"
----

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:

Expand Down

0 comments on commit e266e81

Please sign in to comment.