[camel-spring-boot] branch master updated: CAMEL-15428: camel-spring-boot BOM with just the starter JARs

[da...@apache.org]

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

davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git


The following commit(s) were added to refs/heads/master by this push:
     new cc9a219  CAMEL-15428: camel-spring-boot BOM with just the starter JARs
cc9a219 is described below

commit cc9a2192beda9235663a2f63423ce0a7e53c2f1d
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Mon Aug 24 13:52:50 2020 +0200

    CAMEL-15428: camel-spring-boot BOM with just the starter JARs
---
 docs/modules/ROOT/pages/index.adoc | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
index 9786786..62dbf41 100644
--- a/docs/modules/ROOT/pages/index.adoc
+++ b/docs/modules/ROOT/pages/index.adoc
@@ -12,7 +12,7 @@ Get started by adding the Camel Spring Boot BOM to your Maven `pom.xml` file.
         <!-- Camel BOM -->
         <dependency>
             <groupId>org.apache.camel.springboot</groupId>
-            <artifactId>camel-spring-boot-dependencies</artifactId>
+            <artifactId>camel-spring-boot-bom</artifactId>
             <version>${project.version}</version>
             <type>pom</type>
             <scope>import</scope>
@@ -23,6 +23,8 @@ Get started by adding the Camel Spring Boot BOM to your Maven `pom.xml` file.
 </dependencyManagement>
 ----
 
+The `camel-spring-boot-bom` is a basic BOM that only holds the list of Camel Spring Boot starter JARs.
+
 Next, add the xref:spring-boot.adoc[Camel Spring Boot starter] to startup the xref:manual::camelcontext.adoc[Camel Context].
 
 [source,xml]
@@ -50,6 +52,14 @@ And any xref:list.adoc[component starters] your Spring Boot application requires
     </dependencies>
 ----
 
+== Camel Spring Boot BOM vs Camel Spring Boot Dependencies BOM
+
+There is a curated `camel-spring-boot-dependencies` which is a generated BOM that has adjusted the JARs that both Spring Boot
+and Apache Camel may use to use single shared version that will not conflict. This BOM is what is used to test camel-spring-boot itself.
+However Spring Boot users may want to use _pure_ Camel dependencies and hence why you can use `camel-spring-boot-bom` that only has the
+Camel starter JARs as managed dependencies. This may lead to a classpath conflict if a 3rd party JAR from Spring Boot is not compatible
+with a Camel component.
+
 == Making sure Camel context is running in standalone Spring Boot
 
 To ensure the Spring Boot application keeps running until being stopped or the JVM terminated, typically only need when running Spring Boot standalone, i.e. not with `spring-boot-starter-web` when the web container keeps the JVM running, set the `camel.springboot.main-run-controller=true` property in your configuration. For example in `application.properties`.