onixbyte/onixbyte-bom
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: change to MIT license and reformat codes

Browse Source
This commit is contained in:
zihluwang
2025-06-17 23:07:52 +08:00
parent 7ea6646e89
commit a878422889
73 changed files with 1521 additions and 2522 deletions
Download Patch File Download Diff File Expand all files Collapse all files
version-catalogue/README.md
+14 -11
View File
@@ -1,17 +1,22 @@
# DevKit BOM
# Version Catalogue
The devkit-bom (Bill of Materials) is a Maven POM file provided by OnixByte to manage dependency versions for the DevKit suite of libraries. By incorporating this BOM into your build configuration, you can ensure consistent versioning across all included dependencies without needing to specify versions explicitly in your project files. Published with Gradle metadata, this BOM supports both Maven and Gradle projects, and this document outlines how to integrate and use it effectively in both ecosystems.
The **Version Catalogue** (Bill of Materials) is a Maven POM file provided by OnixByte to manage
dependency versions for the **OnixByte Toolbox**. By incorporating this BOM into your build
configuration, you can ensure consistent versioning across all included dependencies without
needing to specify versions explicitly in your project files. Published with Gradle metadata,
this BOM supports both Maven and Gradle projects, and this document outlines how to integrate
and use it effectively in both ecosystems.
## Using in Maven
Add the `devkit-bom` to your `pom.xml` under `<dependencyManagement>`:
Add the `version-catalogue` to your `pom.xml` under `<dependencyManagement>`:
```xml
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.onixbyte</groupId>
<artifactId>devkit-bom</artifactId>
<artifactId>version-catalogue</artifactId>
<version>${devkit-version}</version>
<type>pom</type>
<scope>import</scope>
@@ -20,7 +25,7 @@ Add the `devkit-bom` to your `pom.xml` under `<dependencyManagement>`:
</dependencyManagement>
```
Then reference dependencies like `devkit-core` without a version.
Then reference any dependency built by OnixByte without a version.
## Using in Gradle
@@ -28,9 +33,8 @@ In your `build.gradle[.kts]`, apply the BOM using the `platform` dependency:
```groovy
dependencies {
implementation platform('com.onixbyte:devkit-bom:2.0.0')
implementation 'com.onixbyte:devkit-core'
implementation 'com.onixbyte:devkit-utils'
implementation platform('com.onixbyte:version-catalogue:2.0.0')
implementation 'com.onixbyte:common-toolbox'
}
```
@@ -38,9 +42,8 @@ If you are using Kotlin DSL:
```kotlin
dependencies {
implementation(platform("com.onixbyte:devkit-bom:2.0.0"))
implementation("com.onixbyte:devkit-core")
implementation("com.onixbyte:devkit-utils")
implementation(platform("com.onixbyte:version-catalogue:2.0.0"))
implementation("com.onixbyte:common-toolbox")
}
```