Skip to content

Add BOM module #264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hyperxpro merged 2 commits into from
Jun 28, 2026
Merged

Add BOM module #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
452a6f7
Add BOM module
hyperxpro Jun 4, 2026
7c8adf9
Merge branch 'main' into add-bom
hyperxpro Jun 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,19 @@ In your pull request, please include a detailed description of the changes you m
</br>
Once your pull request is submitted, it will be reviewed by one or more maintainers. They may ask for additional changes or provide feedback. Once your pull request is approved, it will be merged into the master branch.

# Releasing
When preparing a release, the project version must be bumped in lockstep across **every** `pom.xml` in the repository so all published artifacts (including the BOM) share the same version. Update the `<version>` (or `<parent><version>`) in:

<li> root <code>pom.xml</code> </li>
<li> <code>natives/pom.xml</code> and every <code>natives/&lt;arch&gt;/pom.xml</code> </li>
<li> <code>brotli4j/pom.xml</code> </li>
<li> <code>service/pom.xml</code> </li>
<li> <code>bom/pom.xml</code> </li>
<li> <code>all/pom.xml</code> </li>

</br>
Do not forget <code>bom/pom.xml</code>: if its version is not bumped, the published <code>brotli4j-bom</code> will reference a stale version and consumers importing it will resolve outdated artifacts.

# Attribution
We appreciate all contributions to Brotli4j and want to make sure that contributors are properly credited for their work. In your pull request, please add yourself to the list of contributors in the AUTHORS.md file. You can also add yourself to the list by opening a pull request that only modifies that file.

Expand Down
64 changes: 64 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,70 @@ For maven, the natives will
</dependency>
```

### BOM (Bill of Materials)

If you depend on more than one Brotli4j artifact (for example, when explicitly pinning a specific
native), import the BOM so every Brotli4j dependency stays on a single, consistent version. After
importing the BOM, declare Brotli4j artifacts **without** a `<version>` and the BOM supplies it.

> [!NOTE]
> The BOM only manages versions. It is orthogonal to the Gradle `Brotli4JRule` metadata rule
> (documented below), which automatically selects the correct native for your architecture. Use the
> BOM when you reference individual `native-*` artifacts and want their versions managed centrally.

#### Maven

```xml
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>brotli4j-bom</artifactId>
<version>1.23.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

<dependencies>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>brotli4j</artifactId>
</dependency>
<!-- Optional: pin a specific runtime native (version managed by the BOM) -->
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-linux-x86_64</artifactId>
<scope>runtime</scope>
</dependency>
</dependencies>
```

#### Gradle (Kotlin DSL)

```kotlin
dependencies {
implementation(platform("com.aayushatharva.brotli4j:brotli4j-bom:1.23.0"))

implementation("com.aayushatharva.brotli4j:brotli4j")
// Optional: pin a specific runtime native (version managed by the BOM)
runtimeOnly("com.aayushatharva.brotli4j:native-linux-x86_64")
}
```

#### Gradle (Groovy DSL)

```groovy
dependencies {
implementation platform('com.aayushatharva.brotli4j:brotli4j-bom:1.23.0')

implementation 'com.aayushatharva.brotli4j:brotli4j'
// Optional: pin a specific runtime native (version managed by the BOM)
runtimeOnly 'com.aayushatharva.brotli4j:native-linux-x86_64'
}
```

### Gradle

For gradle, some additional configuration must be added in order to allow gradle to resolve the correct native artifacts automatically,
Expand Down
61 changes: 4 additions & 57 deletions all/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,70 +30,17 @@
<packaging>pom</packaging>

<name>Brotli4j/All</name>
<description>Builds all Brotli4j artifacts</description>
<description>Deprecated alias of brotli4j-bom. Builds all Brotli4j artifacts.</description>

<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>brotli4j</artifactId>
<artifactId>brotli4j-bom</artifactId>
<version>${project.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>service</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-linux-aarch64</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-linux-armv7</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-linux-x86_64</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-linux-s390x</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-linux-ppc64le</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-linux-riscv64</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-osx-aarch64</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-osx-x86_64</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-windows-x86_64</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-windows-aarch64</artifactId>
<version>${project.version}</version>
</dependency>
</dependencies>
</dependencyManagement>

Expand Down
100 changes: 100 additions & 0 deletions bom/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 2020-2025, Aayush Atharva

Brotli4j licenses this file to you 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

http://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>com.aayushatharva.brotli4j</groupId>
<artifactId>brotli4j-parent</artifactId>
<version>1.23.0</version>
</parent>

<artifactId>brotli4j-bom</artifactId>
<packaging>pom</packaging>

<name>Brotli4j/BOM</name>
<description>Brotli4j Bill of Materials (BOM) for dependency version management</description>

<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>brotli4j</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>service</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-linux-x86_64</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-linux-aarch64</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-linux-armv7</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-linux-s390x</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-linux-ppc64le</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-linux-riscv64</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-osx-x86_64</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-osx-aarch64</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-windows-x86_64</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.aayushatharva.brotli4j</groupId>
<artifactId>native-windows-aarch64</artifactId>
<version>${project.version}</version>
</dependency>
</dependencies>
</dependencyManagement>

</project>
1 change: 1 addition & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
<module>natives</module>
<module>brotli4j</module>
<module>service</module>
<module>bom</module>
<module>all</module>
</modules>

Expand Down
Loading