不应提交的 Gradle 配置（即凭据）应该放在哪里？

Question

我正在尝试将 Gradle 构建的工件部署到 Maven 存储库，我需要为此指定凭据。现在这工作正常：

uploadArchives {
    repositories {
        mavenDeployer {
            repository(url: "http://.../nexus/content/repositories/snapshots/") {
                authentication(userName: "admin", password: "admin123")
            }
        }
    }
}

但我不喜欢将凭据存储在源代码管理中。使用 Maven，我将定义一个服务器配置，并在我的 ~/.m2/settings.xml 中分配凭据。我如何使用 Gradle 做类似的事情？

Answer 1

~/.gradle/gradle.properties：

mavenUser=admin
mavenPassword=admin123

build.gradle：

...
authentication(userName: mavenUser, password: mavenPassword)

Answer 2

第一个答案仍然有效，但 API 过去已更改。由于我的编辑没有被接受，我将其作为单独的答案发布。

authentication() 方法仅用于提供身份验证方法（例如 Basic），但不提供任何凭据。

您也不应该使用它，因为它会在失败时打印凭证！

这是他在您的build.gradle 中的样子

    maven {
        credentials {
            username "$mavenUser"
            password "$mavenPassword"
        }
        url 'https://maven.yourcorp.net/'
   }

在gradle.properties 你的用户主目录中放：

mavenUser=admin
mavenPassword=admin123

还要确保将GRADLE_USER_HOME 设置为~/.gradle，否则那里的属性文件将无法解析。

另见：

https://docs.gradle.org/current/userguide/build_environment.html

和

https://docs.gradle.org/current/userguide/dependency_management.html (23.6.4.1)

Answer 3

如果您有用户特定的凭据（即每个开发人员可能有不同的用户名/密码），那么我建议您使用 gradle-properties-plugin。

1. 将默认值放入gradle.properties
2. 每个开发人员都使用gradle-local.properties 覆盖（这应该被 git 忽略）。

这比使用 $USER_HOME/.gradle/gradle.properties 覆盖要好，因为不同的项目可能具有相同的属性名称。

请注意，插件实际上添加了gradle-${environment}.properties，其中${environment} 的默认值为local，并且具有附加功能。使用前请阅读链接。

Answer 4

您还可以在命令行中使用-PmavenUser=user -PmavenPassword=password 提供变量。

由于某种原因您不能使用 gradle.properties 文件，这可能很有用。例如。在构建服务器上，我们使用带有 -g 选项的 Gradle，以便每个构建计划都有自己的 GRADLE_HOME。

Answer 5

您可以将凭据放在属性文件中并使用以下内容读取它：

Properties props = new Properties() 
props.load(new FileInputStream("yourPath/credentials.properties")) 
project.setProperty('props', props)

另一种方法是在操作系统级别定义环境变量并使用以下方法读取它们：

System.getenv()['YOUR_ENV_VARIABLE']

Answer 6

对于那些在 MacOS 上构建并且不喜欢在计算机上以明文形式留下密码的人，您可以使用钥匙串工具来存储凭据，然后将其注入到构建中。归功于维克多·埃里克森。 https://pilloxa.gitlab.io/posts/safer-passwords-in-gradle/

Answer 7

build.gradle

apply from: "./build.gradle.local"
... 
authentication(userName: project.ext.mavenUserName, password: project.ext.mavenPassword)

build.gradle.local（忽略 git）

project.ext.mavenUserName=admin
project.ext.mavenPassword=admin123

Answer 8

根据 7.1.1 的 gradle 文档，我们有如下语法来设置带有凭据的存储库，下面的代码 sn -p 应该在项目的 build.gradle 文件中

repositories {
maven {
    url "http://repo.mycompany.com"
    credentials {
        username "user"
        password "password"
    }
}

}