如何集中 Gradle 构建设置？

Question

假设我正在使用palantir/gradle-git-version Gradle 插件，并在build.gradle.kts 中有以下代码来确定项目版本：

// If release branch, return after incrementing patch version.
// Else, return $lastTag-SNAPSHOT.
val projectVersion: String by lazy {
    val versionDetails: groovy.lang.Closure<VersionDetails> by extra
    with(versionDetails()) {
        if (!lastTag.matches("^(?:(?:\\d+\\.){2}\\d+)\$".toRegex())) {
            throw GradleException("Tag '$lastTag' doesn't match 'MAJOR.MINOR.PATCH' format")
        }
        // If it detached state, get branch name from GitLab CI env var
        val branch = branchName ?: System.getenv("CI_COMMIT_REF_NAME")
        if (branch?.startsWith("release/") == true) {
            val tokens = lastTag.split('.')
            "${tokens[0]}.${tokens[1]}.${tokens[2].toInt() + commitDistance}"
        } else "$lastTag-SNAPSHOT"
    }
}

这可行，但代码在所有项目中重复，除了极少数项目外，很难维护。

这只是一个示例，同样适用于其他在公司/团队中采用某些约定的 Gradle 任务，例如创建Dockerfile。

有什么好的方法可以集中这些代码以便所有项目都可以使用它们？请注意，这样的代码通常不会独立存在，而是依赖于 Gradle 插件。

Answer 1

有什么好的方法可以集中这些代码以便所有项目都可以使用它们？

您需要创建一个custom Gradle plugin 来保存您的项目约定。

如果您在本地安装了 Gradle，则可以使用 Build Init Plugin 创建骨架插件项目。本地安装 Gradle 后，在新项目目录中简单运行 gradle init 并按照提示创建插件项目。

作为一个具体示例（假设您生成了一个前面提到的插件项目），为了应用您的版本控制约定，插件可以是：

// Plugin's build.gradle.kts
dependencies {
    // Add dependency for plugin, GAV can be found on the plugins page:
    // https://plugins.gradle.org/plugin/com.palantir.git-version
    implementation("com.palantir.gradle.gitversion:gradle-git-version:0.12.3")
}

那么版本控制插件可以是：

import com.palantir.gradle.gitversion.VersionDetails
import groovy.lang.Closure
import org.gradle.api.GradleException
import org.gradle.api.Plugin
import org.gradle.api.Project

class VersioningConventionsPlugin : Plugin<Project> {

    override fun apply(project: Project) {
        // Apply plugin to project as you would in the main Gradle build file.
        project.pluginManager.apply("com.palantir.git-version")

        // Configure version conventions
        val projectVersion: String by lazy {

            // Gradle generates some Kotlin DSL code on the fly, in a plugin implementation we don't have that.
            // So we must convert the DSL to the Gradle API.
            val versionDetails: Closure<VersionDetails> = project.extensions.extraProperties.get("versionDetails") as Closure<VersionDetails>

            with(versionDetails.call()) {
                if (!lastTag.matches("^(?:(?:\\d+\\.){2}\\d+)\$".toRegex())) {
                    throw GradleException("Tag '$lastTag' doesn't match 'MAJOR.MINOR.PATCH' format")
                }
                val branch = branchName ?: System.getenv("CI_COMMIT_REF_NAME")
                if (branch?.startsWith("release/") == true) {
                    val tokens = lastTag.split('.')
                    "${tokens[0]}.${tokens[1]}.${tokens[2].toInt() + commitDistance}"
                } else "$lastTag-SNAPSHOT"
            }
        }

        // Set the version as an extra property on the project
        // Accessible via extra["projectVersion"]
        project.extensions.extraProperties["projectVersion"] = projectVersion
    }
}

我给出了一个 Kotlin 示例，因为您的示例使用了 Kotlin DSL。完成约定插件的开发工作后，您将发布到诸如Gradle Plugins repository 之类的存储库。如果是公司内部插件，则将其发布到内部Nexus Repository 或类似网站。

关注maven-publish 插件的文档以获取有关发布的更多详细信息。 Gradle 插件可以像任何其他工件/JAR 一样发布。