anyninesgmbh/gitcredentials

GIT凭据Cloud Native Buildpack

GIT凭据是一个Cloud Native Buildpack，允许应用开发者为需要身份验证的GIT仓库提供凭据。

功能说明

此buildpack的用户可以在应用根目录提供名为buildpack.yml的文件，或通过环境变量来指定凭据。

1. 若在buildpack.yml中找到gitcredentials.credentials数组，或存在特定环境变量，此buildpack将初始化GIT凭据缓存。GIT凭据缓存仅在内存中存储凭据（并在可配置的超时时间后忘记它们）。
2. 此外，它会设置凭据上下文，使GIT知道针对哪个协议、主机和路径使用哪些凭据。
3. 最后，它会设置url.<base>.insteadOf，以引导GIT使用HTTPS而非SSH进行身份验证。这样做的好处是，提供的密码可以是https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line%EF%BC%8C%E6%94%AF%E6%8C%81%E5%B0%86%E8%AE%BF%E9%97%AE%E6%9D%83%E9%99%90%E9%99%90%E5%88%B6%E5%88%B0%E7%89%B9%E5%AE%9A%E8%8C%83%E5%9B%B4%EF%BC%88%E7%89%B9%E5%88%AB%E6%98%AF%E5%8F%AF%E4%BB%A5%E5%B0%86%E4%BB%A4%E7%89%8C%E8%8C%83%E5%9B%B4%E8%AE%BE%E7%BD%AE%E4%B8%BA%22%E5%8F%AA%E8%AF%BB%22%EF%BC%89%E3%80%82

使用方法

1. 通过buildpack.yml

在应用根目录创建名为buildpack.yml的文件，并添加包含以下字段的数组：

yaml
gitcredentials:
  credentials:
    - protocol: https
      host: example.com
      path: /foo.git
      username: username
      password: password
      url: https://example.com

    - protocol: https
      host: example.org
      path: /
      username: other_username
      password: other_password

请阅读git-credential了解"credentials"中指定字段的语义。目前仅支持HTTPS协议，计划支持SSH。

2. 环境变量

环境变量名称对应git-credential的可用字段，字段语义相同。

若变量非必填且用户未指定，则使用buildpack.toml中指定的对应默认变量值。例如，若用户未指定$GIT_CREDENTIALS_PROTOCOL，则其值设为https。

注意

$GIT_CREDENTIALS_USERNAME和$GIT_CREDENTIALS_PASSWORD为必填变量，必须由用户指定。

配置说明

可在buildpack.toml中指定此buildpack的配置。[metadata.configuration]中支持以下配置字段：

要求

1. 支持gitcredentials的Git版本（版本>=1.9.1）。

待办事项

1. 支持SSH协议。
2. 需要更多测试，尤其是构建阶段。

作者

• https://github.com/khaledavarteq%EF%BC%8Chttps://github.com/anynines

许可证

MIT，详见LICENSE