Skip to content

Commit

Permalink
chore(docs): Add documentation for new modules
Browse files Browse the repository at this point in the history
- Kubernetes
- Knative
- Testcontainers
- JBang runtime
  • Loading branch information
christophd committed Nov 19, 2024
1 parent 8407fb1 commit 6572f77
Show file tree
Hide file tree
Showing 18 changed files with 3,342 additions and 713 deletions.
4 changes: 2 additions & 2 deletions scripts/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Please install gnu-sed on your machine (e.g. `brew install gnu-sed`) and set you
To have this script handy all the time it is recommended to either add this `scripts/citrus` binary to the $PATH or add a
symlink from `citrus` into a directory which is already on your execution path.

[source,bash]
[source,shell]
----
# Navigate to the Citrus project directory
cd $PROJECT_DIR
Expand Down Expand Up @@ -96,7 +96,7 @@ Remember a command must be the first argument, but there are additional possibil

To add a new command, just drop a script file into `$PROJECT_DIR/scripts/commands` directory with following structure:

[source,bash]
[source,shell]
----
#!/bin/bash
Expand Down
2 changes: 1 addition & 1 deletion src/manual/configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ properties directly. The location of the `citrus-application.properties` file is
`citrus.application.properties or environment variable `CITRUS_APPLICATION_PROPERTIES`.
`
.Custom property file location.
[source,bash]
[source,shell]
----
CITRUS_APPLICATION_PROPERTIES=file:/custom/path/to/citrus-application.properties
----
Expand Down
6 changes: 3 additions & 3 deletions src/manual/connector-jbang.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[[jbang]]
== JBang support
= JBang support

With https://jbang.dev/[JBang] you can run your `.java` files directly in your shell - instantly without tedious setup.

NOTE: The JBang support in Citrus get enabled by adding a separate Maven module as dependency to your project
NOTE: The JBang support in Citrus gets enabled by adding a separate Maven module as a dependency to your project

[source,xml]
----
Expand All @@ -17,7 +17,7 @@ NOTE: The JBang support in Citrus get enabled by adding a separate Maven module
NOTE: You may wonder why is there another module named `citrus-jbang`! What is the difference compared to the `citrus-jbang-connector` module? The `citrus-jbang` module represents the Citrus JBang app that you can use in JBang to run Citrus tests without any prior setup. The `citrus-jbang-connector` module provides the JBang support to use JBang as part of a test case, for instance in the form of a test action that runs JBang scripts.

[[jbang-action]]
=== JBang action
== JBang action

The JBang test action runs a script or JBang application with a spawned process.
You can call any JBang CLI command and run your JBang app.
Expand Down
Loading

0 comments on commit 6572f77

Please sign in to comment.