An open API service indexing awesome lists of open source software.

https://github.com/eclipse-keyple/keyple-java-bom

Eclipse Keyple™ Project: A Bill of Materials (BOM) for Java/Kotlin applications to manage the versions of all Keyple artifacts
https://github.com/eclipse-keyple/keyple-java-bom

Last synced: 4 months ago
JSON representation

Eclipse Keyple™ Project: A Bill of Materials (BOM) for Java/Kotlin applications to manage the versions of all Keyple artifacts

Awesome Lists containing this project

README

          

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=eclipse_keyple-java-bom&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=eclipse_keyple-java-bom)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=eclipse_keyple-java-bom&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=eclipse_keyple-java-bom)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=eclipse_keyple-java-bom&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=eclipse_keyple-java-bom)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=eclipse_keyple-java-bom&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=eclipse_keyple-java-bom)
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=eclipse_keyple-java-bom&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=eclipse_keyple-java-bom)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=eclipse_keyple-java-bom&metric=coverage)](https://sonarcloud.io/summary/new_code?id=eclipse_keyple-java-bom)

# Keyple Java BOM

**Eclipse Keyple™ Project**
A Bill of Materials (BOM) for Java/Kotlin applications to manage the versions of all Keyple artifacts.

---

## 👁️ Overview

The **Keyple Java BOM** provides a centralized way to manage the versions of all Keyple artifacts for Java and Kotlin
applications. It ensures that projects using multiple Keyple libraries stay consistent and compatible without requiring
explicit version declarations for each dependency.

🔎 Note: The BOM also includes the versions of the [Keypop](https://keypop.org/) dependencies required by Keyple, so you
don’t need to manage them separately.

## 📖 Documentation & Contribution Guide

The full documentation, including the **user guide**, **download information** and **contribution guide**, is available
on the Keyple website [keyple.org](https://keyple.org).

## 🚀 Usage

### With **Maven**

Add the Keyple BOM to your `` section:

```xml



org.eclipse.keyple
keyple-java-bom
2025.09.12
pom
import

```

Then declare the Keyple dependencies without versions:

```xml



org.eclipse.keypop
keypop-reader-java-api

...


org.eclipse.keyple
keyple-common-java-api


org.eclipse.keyple
keyple-service-java-lib

...

```

### With **Gradle**

Import the BOM as a platform:

```kotlin
dependencies {
implementation(platform("org.eclipse.keyple:keyple-java-bom:2025.09.12"))
// Keypop APIs
implementation("org.eclipse.keypop:keypop-reader-java-api")
...
// Keyple components
implementation("org.eclipse.keyple:keyple-common-java-api")
implementation("org.eclipse.keyple:keyple-service-java-lib")
...
}
```

## 📝 Versioning

This project follows a date-based versioning scheme:
- **Format**: `YYYY.MM.DD` (year, month, day).
- **Release cadence**: A new version is released whenever one or more Keyple artifacts are updated.
- **Interpretation**: The version number indicates the release date, not the compatibility level.
→ Users should check the release notes to see which artifacts were updated.

## 🤖 Continuous Integration

This project uses **GitHub Actions** for continuous integration. Every push and pull request triggers automated builds
and checks to ensure code quality and maintain compatibility with the defined specifications.