[camel] 01/01: Camel-JBang SBOM subcommand: Docs

[ac...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

acosentino pushed a commit to branch docs-sbom-jbang
in repository https://gitbox.apache.org/repos/asf/camel.git

commit 7d5eefb3e44e190df4eda1ed13f4eb5c98413d36
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Thu Oct 5 13:33:54 2023 +0200

    Camel-JBang SBOM subcommand: Docs
    
    Signed-off-by: Andrea Cosentino <an...@gmail.com>
---
 .../modules/ROOT/pages/camel-jbang.adoc            | 32 ++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc b/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc
index 2b8ed14ae2b..10331acfab3 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc
@@ -2189,6 +2189,38 @@ org.apache.camel.kamelets:camel-kamelets-utils:0.9.3
 org.apache.camel.kamelets:camel-kamelets:0.9.3
 ----
 
+== Generating SBOM report
+
+[source,bash]
+
+You can generate a SBOM report of your integration by running the following command
+
+----
+camel sbom
+----
+
+By default it will generate a file named `sbom.json` in `cyclonedx` format.
+
+You can also choose to use an `spdx` format with the following command
+
+----
+camel sbom --sbom-format=spdx
+----
+
+You can also choose the target runtime as either _quarkus_ or _spring-boot_ as shown:
+
+----
+camel sbom --runtime=quarkus 
+----
+
+or 
+
+----
+camel sbom --runtime=spring-boot 
+----
+
+by default `camel-main` will be used
+
 === Copying dependency JARs to a specific directory
 
 You can use the `camel dependency copy` command to copy the required JARs to a specific folder.