Skip to content

Add BOM generation.#1569

Merged
vbabanin merged 8 commits intomongodb:mainfrom
vbabanin:JAVA-3808
Feb 20, 2025
Merged

Add BOM generation.#1569
vbabanin merged 8 commits intomongodb:mainfrom
vbabanin:JAVA-3808

Conversation

@vbabanin
Copy link
Copy Markdown
Member

@vbabanin vbabanin commented Nov 28, 2024 •
edited
Loading

This PR introduces a Bill of Materials (BOM) to improve dependency version management, ensure compatibility, and prevent conflicts caused by transitive dependencies.

Motivation

  • Resolves issues, where mismatched versions cause runtime conflicts.
  • Simplifies the management of transitive dependencies by centralizing version control.

Changes

  • Addition of a :bom module in settings.gradle.
  • Updates in gradle/publish.gradle to configure publishing, signing, and Java platform for BOM projects.
  • Addition of bom/build.gradle.kts file to define BOM configurations.

A BOM defines compatible versions of mongodb-driver-sync, mongodb-driver-core, and related components.
Importing the BOM into the dependencyManagement section ensures consistent versions across the dependency tree and eliminates mismatches.

Example of usage in Maven:

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.mongodb</groupId>
            <artifactId>mongodb-driver-bom</artifactId>
            <version>5.4.0</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

JAVA-3808

@vbabanin vbabanin changed the title Add BOM generation for Java, Kotlin and Scala. Add BOM generation. Nov 29, 2024
@vbabanin vbabanin self-assigned this Nov 29, 2024
@vbabanin vbabanin requested a review from rozza January 31, 2025 08:11
@vbabanin
Copy link
Copy Markdown
Member Author

vbabanin commented Feb 4, 2025 •
edited
Loading

The generated BOM POM is available in the snapshot repository for review: Snapshot Repo Link

@vbabanin vbabanin marked this pull request as ready for review February 4, 2025 00:58
rozza
rozza approved these changes Feb 4, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@rozza rozza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - one nit

Good work with the scala multiversion handling 👍

Comment thread gradle/publish.gradle
artifactId = "bom".equals(project.archivesBaseName) ? "mongodb-driver-bom" : project.archivesBaseName
from components.javaPlatform

// Modify the generated POM to add multiple compile versions of driver-scala or bson-scala.
Copy link
Copy Markdown
Member

@rozza rozza Feb 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great catch 👍

Comment thread bom/build.gradle.kts Outdated
api(project(":bson-scala"))
api(project(":driver-scala"))
}
} No newline at end of file
Copy link
Copy Markdown
Member

@rozza rozza Feb 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: no ending new line.

Copy link
Copy Markdown
Member Author

@vbabanin vbabanin Feb 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Applied the suggestion in another comment: #1569 (comment). Thanks!

Comment thread bom/build.gradle.kts Outdated
@vbabanin vbabanin merged commit ff7bae8 into mongodb:main Feb 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rozza rozza rozza approved these changes

Assignees

@vbabanin vbabanin

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@vbabanin @rozza