Infra-Gradle-Plugin

该插件旨在简化 Gradle 项目配置，几行代码就可以迅速开始一个项目。
注意: 仅支持 Kotlin DSL 的 gradle 项目。

快速开始

plugins {
    id("com.labijie.infra") version "your version"
}

infra {
    useDefault {
        infraBomVersion = "3.2.0" //不使用 infra-bom， 请设置为空串("")
        jvmVersion = "17"
    }

    //配置发布包的信息，如果不需要发布包到 maven 或 nexus 无需配置
    publishing {
        pom {
            description = "dxxxx"
            projectUrl = "https://localhost"
            githubScmUrl = "https://localhost"
            githubUrl("hongque-pro", "infra-test")
        }
    }
}

dependencies {
    //...和原生 DSL 用法一致
}

local.properties 支持

支持从 local.properties 文件中使用配置，从 git 排除 local.properties 以实现本地化配置：

适用于本地保存密钥，无需担心被提交到 git 中.

val propertyName = XXXXXX
findPropertyAndLocal(propertyName)

Github Packages 支持

配置 Gihub账号

因为 GitHub Packages 需要配置授权访问，并不是公开访问，你需要配置 username 和 token，支持如下的方式配置

1. 通过文件 gradle.properties 或 local.properties 配置

gpr.user=<your github account>
gpr.key=<PTA OR GITHUB_TOKEN>

2. 通过环境变量配置

gpr.user 也可以通过环境变量 GITHUB_ACTOR 配置
gpr.key 也可以通过环境变量 GITHUB_TOKEN 配置

2. 通过命令行参数配置

Gradle 参数

gradle build -Pgpr.user=<your github account> -Pgpr.key=<PTA OR GITHUB_TOKEN>

JAVA 参数

gradle build -Dgpr.user=<your github account> -Dgpr.key=<PTA OR GITHUB_TOKEN>

4. 直接在 build.gradle.kts 中指定 (不推荐)

infra {
    useGithubAccount("<your github account>", "<PTA OR GITHUB_TOKEN>")
}

关于 Github Token

GITHUB_TOKEN是消费仓库中的包必须的 PTA， 关于如何生成 PTA 参考这里:
https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token

使用 GitHub Packages 仓库

在 gradle.build.kts 中添加以下内容:

allprojects {
    infra {
        useDefault {
            addGitHubRepository("<owner>", "<repository>") //特定的 Github Repository 仓库
        }
    }
}

发布 Maven 包

默认插件已经自动配置了将包发布到 maven 中央仓库，你可以将包发布到 github pages 或私有 nexus 仓库 在 gradle.build.kts 中添加以下内容:

subprojects {
    infra(isBom = true) {
        publishing {
            pom {
                description = "maven bom project"
                githubUrl("hongque-pro", "infra-test")
                artifactId { "mylib" }
            }

            toGithubPackages("hongque-pro", "infra-bom")
            toNexus("http://xxxx", "userA", "password")
        }
    }
}

说明：
publishing 将会自动配置好发布到 maven 官方仓库发布所需的配置，除了你的 maven 账号的签名用密钥 。
toGithubPackages 将会支持将你的包发布到 github 仓库。
toNexus 支持将你的包发布到你自己的私有仓库 (Nexus)。

发布包到 maven 仓库需要签名，具体请参考 maven 官方文档。

发布包也需要授权，可以通过 gradle.properties 或 local.properties 配置：

发布授权配置

发布到 Maven 官方仓库和 Nexus 都需要授权。和 github 账号配置一样，支持环境变量，命令行或 gradle.properties 文件中配置这些账号信息。
下表列出了授权配置的参数:

项目	环境变量	gradle.properties
Mavan 账号	MAVEN_USER	maven.user
Mavan 密码	MAVEN_KEY	maven.key
Nexus 服务器地址	NEXUS_URL	nexus.url
Nexus 账号	NEXUS_USER	nexus.user
Nexus 密码	NEXUS_KEY	nexus.key

gradle.properties 配置都可以通过命令行 -P[参数名] 来配置。

发布包签名配置

签名配置遵循 Gradle Sign 插件配置。

signing.keyId=
signing.password=
signing.secretKeyRingFile=

具体请参考 Sign 插件文档：
https://docs.gradle.org/current/userguide/signing_plugin.html

Maven 使用仓库镜像

默认情况下，插件会自动使用 maven 仓库加速：

• 使用阿里云镜像加速: https://maven.aliyun.com/nexus/content/groups/public/
• 你可以通过环境变量 MAVEN_PROXY 或在 gradle.properties / local.properties 中添加 maven.proxy 配置，指定 nexus 仓库地址，来使用你的私有 maven 仓库。

插件在检测一些环境变量自动关闭 maven 仓库加速：

• GITHUB_JOB
• NO_MAVEN_PROXY

注意，这些环境变量只要存在就会关闭镜像加速，无论它们是什么值。

你可以强制禁止 maven 仓库加速行为：

infra {
    useDefault {
        useMavenProxy = false
    }
}

配置 GitProperties 插件

默认集成了 git properties 插件

插件地址:
https://github.com/n0mer/gradle-git-properties

可以通过如下方式配置插件

infra {
    gitProperties {
        failOnNoGitDirectory = false
    }
}