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 c15c8c2 chore(docs): Partially revert README includes
c15c8c2 is described below
commit c15c8c2b4f85fa6a6d241d1d6ac7c9c234336706
Author: Christoph Deppisch <[email protected]>
AuthorDate: Fri Dec 13 09:52:23 2024 +0100
chore(docs): Partially revert README includes
- README Asciidoc includes did not work out as planned on GitHub markdown
---
.github/workflows/build.yml | 5 +++--
README.adoc | 33 +++++++++++++++++++++++++++++++--
aws-s3-event-based/README.adoc | 10 ++++++++--
ftp/README.adoc | 10 ++++++++--
help.adoc | 7 -------
mqtt/README.adoc | 10 ++++++++--
6 files changed, 58 insertions(+), 17 deletions(-)
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index f87aadc..3343cb9 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -67,8 +67,9 @@ jobs:
jbang citrus@citrusframework/citrus run mqtt.camel.it.yaml
popd
- uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874
# v4.4.0
- if: failure()
+ if: always()
with:
name: dumps
include-hidden-files: true
- path: ${{ github.workspace }}/**/.citrus-jbang/*-output.txt
+ path: |
+ **/.citrus-jbang/*-output.txt
diff --git a/README.adoc b/README.adoc
index 63fdf65..2a25d15 100644
--- a/README.adoc
+++ b/README.adoc
@@ -19,7 +19,30 @@ These examples uses JBang as the CLI which is a great tool
that makes using Java
== Install Camel JBang
-include::install.adoc[]
+First install JBang according to https://www.jbang.dev
+
+When JBang is installed then you should be able to run from a shell:
+
+[source,shell]
+----
+jbang --version
+----
+
+This will output the version of JBang.
+
+To run this example you can install Camel on JBang via:
+
+[source,shell]
+----
+jbang app install camel@apache/camel
+----
+
+Which allows to run Camel with `camel` as shown below.
+
+[source,shell]
+----
+camel --version
+----
== Integration testing
@@ -58,4 +81,10 @@ You can also find a set of various Camel JBang examples at:
https://github.com/a
== Help and contributions
-include::help.adoc[]
+If you hit any problem using Camel or have some feedback, then please
+https://camel.apache.org/community/support/[let us know].
+
+We also love contributors, so
+https://camel.apache.org/community/contributing/[get involved] :-)
+
+The Camel riders!
diff --git a/aws-s3-event-based/README.adoc b/aws-s3-event-based/README.adoc
index 6af7529..c4e2c3e 100644
--- a/aws-s3-event-based/README.adoc
+++ b/aws-s3-event-based/README.adoc
@@ -6,7 +6,7 @@ Through the usage of EventBridge and SQS Services you'll be
able to consume even
== Install Camel JBang
-include::../install.adoc[]
+include::../install.adoc[see installation]
== Setup the AWS S3 bucket, SQS Queue and EventBridge Rule
@@ -169,4 +169,10 @@ At the end the AWS environment on your account will be
clean.
== Help and contributions
-include::../help.adoc[]
+If you hit any problem using Camel or have some feedback, then please
+https://camel.apache.org/community/support/[let us know].
+
+We also love contributors, so
+https://camel.apache.org/community/contributing/[get involved] :-)
+
+The Camel riders!
diff --git a/ftp/README.adoc b/ftp/README.adoc
index 0a73ee9..c6e69f6 100644
--- a/ftp/README.adoc
+++ b/ftp/README.adoc
@@ -6,7 +6,7 @@ image::ftp-kaoto.png[Apache Camel Kaoto online designer]
== Install Camel JBang
-include::../install.adoc[]
+include::../install.adoc[see installation]
== Running ActiveMQ and FTP server
@@ -89,4 +89,10 @@ This example was also covered in the following YouTube
video: https://youtu.be/V
== Help and contributions
-include::../help.adoc[]
+If you hit any problem using Camel or have some feedback, then please
+https://camel.apache.org/community/support/[let us know].
+
+We also love contributors, so
+https://camel.apache.org/community/contributing/[get involved] :-)
+
+The Camel riders!
diff --git a/help.adoc b/help.adoc
deleted file mode 100644
index 32b2c88..0000000
--- a/help.adoc
+++ /dev/null
@@ -1,7 +0,0 @@
-If you hit any problem using Camel or have some feedback, then please
-https://camel.apache.org/community/support/[let us know].
-
-We also love contributors, so
-https://camel.apache.org/community/contributing/[get involved] :-)
-
-The Camel riders!
diff --git a/mqtt/README.adoc b/mqtt/README.adoc
index 888562b..1b5d303 100644
--- a/mqtt/README.adoc
+++ b/mqtt/README.adoc
@@ -7,7 +7,7 @@ image::mqtt-kaoto.png[Apache Camel Kaoto online designer]
== Install Camel JBang
-include::../install.adoc[]
+include::../install.adoc[see installation]
== How to run
@@ -95,4 +95,10 @@ The test sends some test data to the MQTT broker and
verifies that the Camel rou
== Help and contributions
-include::../help.adoc[]
+If you hit any problem using Camel or have some feedback, then please
+https://camel.apache.org/community/support/[let us know].
+
+We also love contributors, so
+https://camel.apache.org/community/contributing/[get involved] :-)
+
+The Camel riders!
