This is an automated email from the ASF dual-hosted git repository.
ppalaga pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
The following commit(s) were added to refs/heads/master by this push:
new 60f2bb3 update create new extension guide : add update of
test-categories.yaml
60f2bb3 is described below
commit 60f2bb3ed87c86ef34a6c59e5965eab2b677acda
Author: Zineb Bendhiba <[email protected]>
AuthorDate: Wed Aug 19 11:09:30 2020 +0200
update create new extension guide : add update of test-categories.yaml
---
.../pages/contributor-guide/create-new-extension.adoc | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git
a/docs/modules/ROOT/pages/contributor-guide/create-new-extension.adoc
b/docs/modules/ROOT/pages/contributor-guide/create-new-extension.adoc
index 00358f9..ea6f85f 100644
--- a/docs/modules/ROOT/pages/contributor-guide/create-new-extension.adoc
+++ b/docs/modules/ROOT/pages/contributor-guide/create-new-extension.adoc
@@ -36,10 +36,12 @@ The above sequence of commands does the following:
* It creates a basic `FooAbcProcessor` class in the deployment module.
* It also creates a stub of an integration test module under
`integration-tests/foo-abc`.
+
+6. Add the extension name to the right category in
`tooling/scripts/test-categories.yaml` file.
++
Compilation performed immediately after generating the modules should pass
flawlessly but running the tests will fail
because the test project needs to get finished. You need to build `poms/bom`
and `poms/bom-deployment` one time first.
-6. Review the generated
+7. Review the generated
`extensions/foo-abc/runtime/src/main/resources/META-INF/quarkus-extension.yaml`
file.
+
The
@@ -58,23 +60,23 @@ because the test project needs to get finished. You need to
build `poms/bom` and
+
Check the xref:contributor-guide/extension-metadata.adoc[Extension
metadata] page for more details about the `quarkus-extension.yaml` file
-7. Review the dependencies in the generated runtime and deployment modules. In
case the given library is supported by
+8. Review the dependencies in the generated runtime and deployment modules. In
case the given library is supported by
Quarkus, you may want to add a dependency on the corresponding Quarkus
extension.
-8. Complete the integration test module under `integration-tests/foo-abc`.
Make sure you test both the consumer and the
+9. Complete the integration test module under `integration-tests/foo-abc`.
Make sure you test both the consumer and the
producer of the component (if the component supports both). Make sure the
tests are passing both in the JVM mode
(`mvn test`) and in the native mode (`mvn verify -Pnative`).
-9. In case of problems, consult the
https://quarkus.io/guides/extension-authors-guide[Quarkus extension author's
guide],
+10. In case of problems, consult the
https://quarkus.io/guides/extension-authors-guide[Quarkus extension author's
guide],
ask for help in the given GitHub issue or via
https://gitter.im/apache/camel-quarkus[Camel Quarkus chat].
-10. Read the xref:contributor-guide/extension-documentation.adoc[Extension
documentation] page and add `configuration.adoc`,
+11. Read the xref:contributor-guide/extension-documentation.adoc[Extension
documentation] page and add `configuration.adoc`,
`usage.adoc`, etc. in `src/main/doc` directory of the runtime module if
necessary.
+
After completing the extension documentation, run `mvn clean install
-DskipTests`
from the root of the source tree to add your extension to the autogenerated
list of extensions.
-11. Before sending a pull request, please make sure you have run the following
Maven command from the project root folder:
+12. Before sending a pull request, please make sure you have run the following
Maven command from the project root folder:
+
[source,shell]
----
@@ -89,6 +91,6 @@ The above command will perform the following tasks:
+
Review the result visually.
-12. Please squash your commits before sending a pull request.
+13. Please squash your commits before sending a pull request.
Good luck!
