Skip to content
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.

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

Introduce mirai-bom for dependency management #1417

Merged
merged 3 commits into from
Oct 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 13 additions & 3 deletions docs/ConfiguringProjects.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,16 +69,26 @@ dependencies {

### 分离 API 和实现(可选)

mirai 在开发时需要 `net.mamoe:mirai-core-api`, 在运行时需要 `net.mamoe:mirai-core`。可以在开发和编译时只依赖 `mirai-core-api`,会减轻对 IDE 的负担。
Mirai 在开发时需要 `net.mamoe:mirai-core-api`, 在运行时需要 `net.mamoe:mirai-core`。可以在开发和编译时只依赖 `mirai-core-api`,会减轻对 IDE 的负担。
在 2.8.0 起 Mirai 提供 `mirai-bom` 用于自动协调 Mirai 不同组件的版本信息,这是引用 Mirai 平台的首选方式。
使用 `mirai-bom` 也会对 Dependabot 等自动化依赖管理程序更加友好。
```kotlin
dependencies {
val miraiVersion = "2.7.0"
api(platform("net.mamoe:mirai-bom:2.8.0"))
api("net.mamoe:mirai-core-api") // 编译代码使用
runtimeOnly("net.mamoe:mirai-core") // 运行时使用
}
```
也可以继续使用如下传统方式,但务必保证 `mirai-core-api` 和 `mirai-core` 的版本号相一致,以避免潜在的异常。
尤其注意 Dependabot 等依赖管理程序可能会导致模块版本不同。
```kotlin
dependencies {
val miraiVersion = "2.8.0"
api("net.mamoe", "mirai-core-api", miraiVersion) // 编译代码使用
runtimeOnly("net.mamoe", "mirai-core", miraiVersion) // 运行时使用
}
```


## B. 使用 Maven

在 `pom.xml` 中添加 mirai 依赖:
Expand Down
38 changes: 38 additions & 0 deletions mirai-bom/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
plugins {
`java-platform`
`maven-publish`
}

description = "Mirai BOM"

rootProject.subprojects
.filter { it.path != project.path }
.forEach { project.evaluationDependsOn(it.path) }

dependencies {
constraints {
rootProject.subprojects
.filter { it.path != project.path }
.filter { it.extensions.findByName("publishing") != null }
.forEach { subProject ->
subProject.publishing.publications
.withType<MavenPublication>()
.forEach {
[email protected]("${it.groupId}:${it.artifactId}:${it.version}")
}
}
}
}

publishing {
publications {
create<MavenPublication>("myPlatform") {
groupId = rootProject.group.toString()
artifactId = "mirai-bom"
version = Versions.project
from(components["javaPlatform"])
setupPom(project)
configGpgSign(project)
}
}
}
1 change: 1 addition & 0 deletions settings.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ include(":mirai-core-utils")
include(":mirai-core-api")
include(":mirai-core")
include(":mirai-core-all")
include(":mirai-bom")

include(":binary-compatibility-validator")
include(":binary-compatibility-validator-android")
Expand Down