This is an automated email from the ASF dual-hosted git repository.
cdeppisch pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-jbang-examples.git
The following commit(s) were added to refs/heads/main by this push:
new 819f7c6 fix(#14): Add docs how to install Citrus JBang
819f7c6 is described below
commit 819f7c658054258bebba2343d28394e3e4a347a7
Author: Christoph Deppisch <cdeppi...@redhat.com>
AuthorDate: Thu Jan 9 15:31:24 2025 +0100
fix(#14): Add docs how to install Citrus JBang
---
README.adoc | 3 ++-
ftp/README.adoc | 3 ++-
install-citrus.adoc | 20 ++++++++++++++++++++
install.adoc | 4 ++--
mqtt/README.adoc | 3 ++-
5 files changed, 28 insertions(+), 5 deletions(-)
diff --git a/README.adoc b/README.adoc
index 2a25d15..a9f4119 100644
--- a/README.adoc
+++ b/README.adoc
@@ -55,7 +55,7 @@ You need to install Citrus as a JBang app, too:
jbang app install citrus@citrusframework/citrus
----
-Now you can start running commands for the Citrus JBang app with just calling
`citrus`:
+Now you can start running commands for the Citrus JBang app with `citrus`:
[source,shell]
----
@@ -69,6 +69,7 @@ You can run the test with Citrus JBang like this:
[source,shell]
----
+cd test
citrus run mqtt.camel.it.yaml
----
diff --git a/ftp/README.adoc b/ftp/README.adoc
index c6e69f6..d043d6a 100644
--- a/ftp/README.adoc
+++ b/ftp/README.adoc
@@ -74,12 +74,13 @@ Then you can browse: http://localhost:8080/q/dev to
introspect the running Camel
== Integration testing
The example provides an automated integration test (`ftp.camel.it.yaml`) that
you can run with the https://citrusframework.org/[Citrus] test framework.
-Please make sure to install Citrus as a JBang app, too.
+Please make sure to install Citrus as a JBang application (see
link:../../install-citrus.adoc[Citrus installation guide]).
You may run the test with:
[source,shell]
----
+cd test
citrus run ftp.camel.it.yaml
----
diff --git a/install-citrus.adoc b/install-citrus.adoc
new file mode 100644
index 0000000..12a1df6
--- /dev/null
+++ b/install-citrus.adoc
@@ -0,0 +1,20 @@
+First install JBang according to the https://www.jbang.dev/download/[JBang
installation guide]
+
+For a more convenient way to use the Citrus JBang scripts you can install
Citrus as a JBang app.
+
+.Install Citrus app
+[source,shell]
+----
+jbang trust add https://github.com/citrusframework/citrus/
+jbang app install citrus@citrusframework/citrus
+----
+
+Now you can run Citrus with `citrus` to execute some tests:
+
+.Run my.camel.it.yaml
+[source,shell]
+----
+citrus run my.camel.it.yaml
+----
+
+For more information about using Citrus JBang please refer to
diff --git a/install.adoc b/install.adoc
index 27b1f3d..826317e 100644
--- a/install.adoc
+++ b/install.adoc
@@ -1,6 +1,6 @@
-First install JBang according to https://www.jbang.dev
+First install JBang according to the https://www.jbang.dev/download/[JBang
installation guide]
-When JBang is installed then you should be able to run from a shell:
+When JBang is installed you should be able to run from a shell:
[source,shell]
----
diff --git a/mqtt/README.adoc b/mqtt/README.adoc
index d4c7ddc..747da22 100644
--- a/mqtt/README.adoc
+++ b/mqtt/README.adoc
@@ -81,12 +81,13 @@ camel stop mqtt
== Integration testing
The example provides an automated integration test (`mqtt.camel.it.yaml`) that
you can run with the https://citrusframework.org/[Citrus] test framework.
-Please make sure to have installed Citrus as a JBang application.
+Please make sure to install Citrus as a JBang application (see
link:../../install-citrus.adoc[Citrus installation guide]).
You can run the test with:
[source,shell]
----
+cd test
citrus run mqtt.camel.it.yaml
----
