refactor: Add a top-level BOM project for easy consumption of the pro…

…duced binaries. (#562) Closes #541. --------- Co-authored-by: Gerrit Meier <[email protected]>
neo4j · Mar 11, 2024 · cce2a30 · cce2a30
1 parent a38f66a
commit cce2a30
Show file tree

Hide file tree

Showing 20 changed files with 212 additions and 18 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -58,7 +58,7 @@ jobs:
         run: >
           ./mvnw --no-transfer-progress
           -P$USE_SONAR -Dsonar.projectKey=neo4j-jdbc -Dsonar.projectName='neo4j-jdbc'
-          -am -pl neo4j-jdbc -pl neo4j-jdbc-bundle -pl neo4j-jdbc-full-bundle          
+          -am -pl neo4j-jdbc -pl neo4j-jdbc-bom -pl neo4j-jdbc-bundle -pl neo4j-jdbc-full-bundle          
           clean install
 
   integration_tests:

diff --git a/.gitignore b/.gitignore
@@ -34,3 +34,4 @@ dependency-reduced-pom.xml
 \.*.swp
 .env
 Neo4j-*-Created-*-*-*.txt
+.flattened-pom.xml
diff --git a/benchkit/pom.xml b/benchkit/pom.xml
@@ -38,6 +38,13 @@
 
 	<dependencyManagement>
 		<dependencies>
+			<dependency>
+				<groupId>org.neo4j</groupId>
+				<artifactId>neo4j-jdbc-bom</artifactId>
+				<version>${project.version}</version>
+				<type>pom</type>
+				<scope>import</scope>
+			</dependency>
 			<dependency>
 				<!-- Import dependency management from Spring Boot -->
 				<groupId>org.springframework.boot</groupId>
@@ -52,7 +59,6 @@
 		<dependency>
 			<groupId>org.neo4j</groupId>
 			<artifactId>neo4j-jdbc</artifactId>
-			<version>${project.version}</version>
 		</dependency>
 		<dependency>
 			<groupId>org.openapitools</groupId>

diff --git a/dist/pom.xml b/dist/pom.xml
@@ -34,6 +34,18 @@
 	<name>Neo4j JDBC Driver (Distribution)</name>
 	<description>Zipped distribution containing the full bundle plus manual</description>
 
+	<dependencyManagement>
+		<dependencies>
+			<dependency>
+				<groupId>org.neo4j</groupId>
+				<artifactId>neo4j-jdbc-bom</artifactId>
+				<version>${project.version}</version>
+				<type>pom</type>
+				<scope>import</scope>
+			</dependency>
+		</dependencies>
+	</dependencyManagement>
+
 	<dependencies>
 		<dependency>
 			<groupId>org.neo4j</groupId>
@@ -43,7 +55,6 @@
 		<dependency>
 			<groupId>org.neo4j</groupId>
 			<artifactId>neo4j-jdbc-full-bundle</artifactId>
-			<version>${project.version}</version>
 		</dependency>
 	</dependencies>
 
@@ -121,5 +132,4 @@
 			</plugin>
 		</plugins>
 	</build>
-
 </project>
diff --git a/docs/pom.xml b/docs/pom.xml
@@ -42,6 +42,18 @@
 		<sonar.coverage.jacoco.xmlReportPaths>${basedir}/../${aggregate.report.dir}</sonar.coverage.jacoco.xmlReportPaths>
 	</properties>
 
+	<dependencyManagement>
+		<dependencies>
+			<dependency>
+				<groupId>org.neo4j</groupId>
+				<artifactId>neo4j-jdbc-bom</artifactId>
+				<version>${project.version}</version>
+				<type>pom</type>
+				<scope>import</scope>
+			</dependency>
+		</dependencies>
+	</dependencyManagement>
+
 	<dependencies>
 		<dependency>
 			<groupId>com.opencsv</groupId>
@@ -50,7 +62,6 @@
 		<dependency>
 			<groupId>org.neo4j</groupId>
 			<artifactId>neo4j-jdbc-full-bundle</artifactId>
-			<version>${project.version}</version>
 		</dependency>
 	</dependencies>
 

diff --git a/docs/src/main/asciidoc/modules/ROOT/pages/distribution.adoc b/docs/src/main/asciidoc/modules/ROOT/pages/distribution.adoc
@@ -57,6 +57,8 @@ Depending on your use-case or your environment you pick one or the other bundle,
 
 Pick this distribution if you have an application that uses dependencies management in which you don't have to care about dealing with binary artifacts yourself.
 
+IMPORTANT: We offer a Maven BOM project, which you should import when using the individual modules, so that you have always a consistent set of versions. The coordinates are `{group-id}:neo4j-jdbc-bom`.
+
 For Maven you will want to use this dependency declaration:
 
 [source,xml,subs="verbatim,attributes"]

diff --git a/neo4j-jdbc-bom/pom.xml b/neo4j-jdbc-bom/pom.xml
@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright (c) 2023-2024 "Neo4j,"
+    Neo4j Sweden AB [https://neo4j.com]
+
+    This file is part of Neo4j.
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        https://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+
+	<parent>
+		<groupId>org.neo4j</groupId>
+		<artifactId>neo4j-jdbc-parent</artifactId>
+		<version>6.0.0-SNAPSHOT</version>
+	</parent>
+
+	<artifactId>neo4j-jdbc-bom</artifactId>
+
+	<packaging>pom</packaging>
+	<name>Neo4j JDBC Driver (BOM)</name>
+	<description>The BOM for the Neo4j JDBC Driver</description>
+
+	<dependencyManagement>
+		<dependencies>
+			<dependency>
+				<groupId>org.neo4j</groupId>
+				<artifactId>neo4j-jdbc</artifactId>
+				<version>${project.version}</version>
+			</dependency>
+			<dependency>
+				<groupId>org.neo4j</groupId>
+				<artifactId>neo4j-jdbc-bundle</artifactId>
+				<version>${project.version}</version>
+			</dependency>
+			<dependency>
+				<groupId>org.neo4j</groupId>
+				<artifactId>neo4j-jdbc-full-bundle</artifactId>
+				<version>${project.version}</version>
+			</dependency>
+			<dependency>
+				<groupId>org.neo4j</groupId>
+				<artifactId>neo4j-jdbc-translator-impl</artifactId>
+				<version>${project.version}</version>
+			</dependency>
+			<dependency>
+				<groupId>org.neo4j</groupId>
+				<artifactId>neo4j-jdbc-translator-spi</artifactId>
+				<version>${project.version}</version>
+			</dependency>
+		</dependencies>
+	</dependencyManagement>
+
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.codehaus.mojo</groupId>
+				<artifactId>flatten-maven-plugin</artifactId>
+				<version>1.6.0</version>
+				<executions>
+					<execution>
+						<id>flatten</id>
+						<goals>
+							<goal>flatten</goal>
+						</goals>
+						<phase>process-resources</phase>
+						<configuration>
+							<updatePomFile>true</updatePomFile>
+							<flattenMode>bom</flattenMode>
+							<pomElements>
+								<properties>remove</properties>
+							</pomElements>
+						</configuration>
+					</execution>
+					<execution>
+						<id>flatten-clean</id>
+						<goals>
+							<goal>clean</goal>
+						</goals>
+						<phase>clean</phase>
+					</execution>
+				</executions>
+			</plugin>
+		</plugins>
+	</build>
+</project>
diff --git a/neo4j-jdbc-bundle/pom.xml b/neo4j-jdbc-bundle/pom.xml
@@ -38,11 +38,22 @@
 		<sonar.coverage.jacoco.xmlReportPaths>${basedir}/../${aggregate.report.dir}</sonar.coverage.jacoco.xmlReportPaths>
 	</properties>
 
+	<dependencyManagement>
+		<dependencies>
+			<dependency>
+				<groupId>org.neo4j</groupId>
+				<artifactId>neo4j-jdbc-bom</artifactId>
+				<version>${project.version}</version>
+				<type>pom</type>
+				<scope>import</scope>
+			</dependency>
+		</dependencies>
+	</dependencyManagement>
+
 	<dependencies>
 		<dependency>
 			<groupId>org.neo4j</groupId>
 			<artifactId>neo4j-jdbc</artifactId>
-			<version>${project.version}</version>
 		</dependency>
 		<dependency>
 			<groupId>org.assertj</groupId>

diff --git a/neo4j-jdbc-full-bundle/pom.xml b/neo4j-jdbc-full-bundle/pom.xml
@@ -38,16 +38,26 @@
 		<sonar.coverage.jacoco.xmlReportPaths>${basedir}/../${aggregate.report.dir}</sonar.coverage.jacoco.xmlReportPaths>
 	</properties>
 
+	<dependencyManagement>
+		<dependencies>
+			<dependency>
+				<groupId>org.neo4j</groupId>
+				<artifactId>neo4j-jdbc-bom</artifactId>
+				<version>${project.version}</version>
+				<type>pom</type>
+				<scope>import</scope>
+			</dependency>
+		</dependencies>
+	</dependencyManagement>
+
 	<dependencies>
 		<dependency>
 			<groupId>org.neo4j</groupId>
 			<artifactId>neo4j-jdbc</artifactId>
-			<version>${project.version}</version>
 		</dependency>
 		<dependency>
 			<groupId>org.neo4j</groupId>
 			<artifactId>neo4j-jdbc-translator-impl</artifactId>
-			<version>${project.version}</version>
 		</dependency>
 		<dependency>
 			<groupId>org.assertj</groupId>

diff --git a/neo4j-jdbc-it/mybatis-smoke-tests/pom.xml b/neo4j-jdbc-it/mybatis-smoke-tests/pom.xml
@@ -57,7 +57,6 @@
 		<dependency>
 			<groupId>org.neo4j</groupId>
 			<artifactId>neo4j-jdbc</artifactId>
-			<version>${project.version}</version>
 		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>

diff --git a/neo4j-jdbc-it/neo4j-jdbc-it-cp/pom.xml b/neo4j-jdbc-it/neo4j-jdbc-it-cp/pom.xml
@@ -50,13 +50,11 @@
 		<dependency>
 			<groupId>org.neo4j</groupId>
 			<artifactId>neo4j-jdbc</artifactId>
-			<version>${project.version}</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
 			<groupId>org.neo4j</groupId>
 			<artifactId>neo4j-jdbc-translator-impl</artifactId>
-			<version>${project.version}</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>

diff --git a/neo4j-jdbc-it/neo4j-jdbc-it-mp/pom.xml b/neo4j-jdbc-it/neo4j-jdbc-it-mp/pom.xml
@@ -41,13 +41,11 @@
 		<dependency>
 			<groupId>org.neo4j</groupId>
 			<artifactId>neo4j-jdbc</artifactId>
-			<version>${project.version}</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
 			<groupId>org.neo4j</groupId>
 			<artifactId>neo4j-jdbc-translator-impl</artifactId>
-			<version>${project.version}</version>
 			<scope>test</scope>
 		</dependency>
 	</dependencies>

diff --git a/neo4j-jdbc-it/pom.xml b/neo4j-jdbc-it/pom.xml
@@ -41,6 +41,18 @@
 		<module>quarkus-smoke-tests</module>
 	</modules>
 
+	<dependencyManagement>
+		<dependencies>
+			<dependency>
+				<groupId>org.neo4j</groupId>
+				<artifactId>neo4j-jdbc-bom</artifactId>
+				<version>${project.version}</version>
+				<type>pom</type>
+				<scope>import</scope>
+			</dependency>
+		</dependencies>
+	</dependencyManagement>
+
 	<dependencies>
 		<dependency>
 			<groupId>org.assertj</groupId>

diff --git a/neo4j-jdbc-it/quarkus-smoke-tests/pom.xml b/neo4j-jdbc-it/quarkus-smoke-tests/pom.xml
@@ -78,7 +78,6 @@
 		<dependency>
 			<groupId>org.neo4j</groupId>
 			<artifactId>neo4j-jdbc-full-bundle</artifactId>
-			<version>${project.version}</version>
 		</dependency>
 		<dependency>
 			<groupId>io.quarkus</groupId>

diff --git a/neo4j-jdbc-it/spring-boot-smoke-tests/pom.xml b/neo4j-jdbc-it/spring-boot-smoke-tests/pom.xml
@@ -48,7 +48,6 @@
 		<dependency>
 			<groupId>org.neo4j</groupId>
 			<artifactId>neo4j-jdbc-full-bundle</artifactId>
-			<version>${project.version}</version>
 		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>

diff --git a/neo4j-jdbc-test-results/pom.xml b/neo4j-jdbc-test-results/pom.xml
@@ -32,11 +32,22 @@
 	<name>Neo4j JDBC Driver (Test Results)</name>
 	<description>Aggregator project for test results.</description>
 
+	<dependencyManagement>
+		<dependencies>
+			<dependency>
+				<groupId>org.neo4j</groupId>
+				<artifactId>neo4j-jdbc-bom</artifactId>
+				<version>${project.version}</version>
+				<type>pom</type>
+				<scope>import</scope>
+			</dependency>
+		</dependencies>
+	</dependencyManagement>
+
 	<dependencies>
 		<dependency>
 			<groupId>org.neo4j</groupId>
 			<artifactId>neo4j-jdbc</artifactId>
-			<version>${project.version}</version>
 		</dependency>
 		<dependency>
 			<groupId>org.neo4j</groupId>

diff --git a/neo4j-jdbc-translator/impl/pom.xml b/neo4j-jdbc-translator/impl/pom.xml
@@ -50,7 +50,6 @@
 		<dependency>
 			<groupId>org.neo4j</groupId>
 			<artifactId>neo4j-jdbc-translator-spi</artifactId>
-			<version>${project.version}</version>
 		</dependency>
 		<dependency>
 			<!-- It is referenced by jOOQ and will lead to compiler warnings unless present during compilation. Using provided scope so that it never appears as transitive dependency. -->

diff --git a/neo4j-jdbc-translator/pom.xml b/neo4j-jdbc-translator/pom.xml
@@ -37,4 +37,16 @@
 		<module>spi</module>
 		<module>impl</module>
 	</modules>
+
+	<dependencyManagement>
+		<dependencies>
+			<dependency>
+				<groupId>org.neo4j</groupId>
+				<artifactId>neo4j-jdbc-bom</artifactId>
+				<version>${project.version}</version>
+				<type>pom</type>
+				<scope>import</scope>
+			</dependency>
+		</dependencies>
+	</dependencyManagement>
 </project>
-Original file line number
+Diff line change
@@ Expand Up / @@ -34,3 +34,4 @@ dependency-reduced-pom.xml @@
     \.*.swp
     .env
     Neo4j-*-Created-*-*-*.txt
+    .flattened-pom.xml