Jenkins 凭证插件

• Credentials Binding
  • 笔记

Credentials Binding

官网地址：Credentials Binding

允许将凭据绑定到环境变量，以便在其他构建步骤中使用。

您可能有 jarsigner 的密钥库、密码列表或其他机密文件或字符串，您希望作业使用这些文件或字符串，但不应将其保存在其 SCM 中，甚至从其 config.xml 中可见。将这些文件保存在服务器上并通过绝对路径引用它们需要您具有服务器登录名，并且不适用于代理。该插件为您提供了一种简单的方法来打包所有作业的机密文件和密码，并在构建期间使用单个环境变量访问它们。

要使用，请首先转到 Credentials 链接并添加类型为 Secret file 或 Secret text 的项目。现在在自由式作业中，选中 Use secret text(s) or file(s) 框，并添加一些将使用凭据的变量绑定。生成的环境变量可以从 shell 脚本构建步骤等进行访问。（您可能希望使用 set +x 启动任何 shell 脚本，或者使用 @echo off 启动批处理脚本。

有关其工作原理的更多详细信息，请查看 CloudBees 上的 Injecting secrets into builds 文章。

从管道作业中，定义凭据，然后检查 Snippet Generator 以获取 withCredentials 步骤的语法示例。构建日志中的任何机密都将自动屏蔽。

用户名密码类型凭据的典型示例（此处示例）如下所示：

withCredentials([usernamePassword(credentialsId: 'amazon', usernameVariable: 'USERNAME', passwordVariable: 'PASSWORD')]) {
  // available as an env variable, but will be masked if you try to print it out any which way
  // note: single quotes prevent Groovy interpolation; expansion is by Bourne Shell, which is what you want
  sh 'echo $PASSWORD'
  // also available as a Groovy variable
  echo USERNAME
  // or inside double quotes for string interpolation
  echo "username is $USERNAME"
}

笔记

只要有可能，就应该使用单引号 ' 而不是双引号 "。这在管道中尤其重要，因为管道引擎和外部解释器都可以解释语句，例如：Unix shell（sh）或 Windows 命令（bat）或 Powershell（ps）。这减少了密码屏蔽和命令处理的复杂性。上述示例中的第一步正确地演示了这一点。它引用一个环境变量，因此单引号字符串将其未经处理的值传递给 sh 步骤，shell 解释 $PASSWORD。接下来的两个步骤使用基本的管道回显步骤。最后一个需要使用双引号，以便 string interpolation 由管道 DSL 执行。

有关更多信息，请参阅 Credentials Binding Plugin 的管道步骤参考。