track0x1/git-resource

Git资源

跟踪http://git-scm.com/仓库中的提交。

源配置

• uri：必填。仓库的位置。

• branch：要跟踪的分支。若资源仅用于get步骤，此参数可选（默认值为master）；但在put步骤中使用时，此参数必填。

• private_key：可选。拉取/推送时使用的私钥。示例：

  private_key: |
    -----BEGIN RSA PRIVATE KEY-----
    MIIEowIBAAKCAQEAtCS10/f7W7lkQaSgD/mVeaSOvSF9ql4hf/zfMwfVGgHWjj+W
    <更多文本>
    DWiJL+OFeg9kawcUL6hQ8JeXPhlImG6RTUffma9+iGQyyBMCGd1l
    -----END RSA PRIVATE KEY-----
  

  注意：您可使用流水线模板隐藏源代码控制中的私钥（更多信息：https://concourse.ci/fly-set-pipeline.html）。

• username：可选。HTTP(S)认证的用户名，适用于仅支持HTTP/HTTPS且需认证的场景。

• password：可选。HTTP(S)认证的密码，可通过流水线模板隐藏（更多信息：https://concourse.ci/fly-set-pipeline.html）。

• paths：可选。glob模式列表，仅指定文件的更改会触发新版本。

• ignore_user：可选。grep模式的用户名单，用于避免重复提交。

• ignore_paths：可选。与paths相反，指定文件的更改会被忽略。

• skip_ssl_verification：可选。跳过Git SSL验证，通过导出GIT_SSL_NO_VERIFY=true实现。

• tag_filter：可选。glob模式的标签过滤规则，仅匹配标签的提交会被检测。

• git_config：可选。Git全局配置列表（键值对），用于设置如credential.helper等选项。

• disable_ci_skip：可选。允许检测含[ci skip]或[skip ci]的提交。

• commit_verification_keys：可选。GPG公钥数组，用于验证提交签名。

• commit_verification_key_ids：可选。GPG公钥ID数组，将从指定密钥服务器获取密钥用于签名验证。

• gpg_keyserver：可选。GPG密钥服务器，默认值为hkp:///keys.gnupg.net/。

• git_crypt_key：可选。Base64编码的git-crypt密钥，用于解锁加密仓库。

• https_tunnel：可选。HTTPS代理配置，用于隧道传输SSH Git命令，包含proxy_host（必填）、proxy_port（必填）、proxy_user（可选）、proxy_password（可选）。

示例

私有仓库带HTTPS代理的配置：

yaml
resources:
- name: source-code
  type: git
  source:
    uri: git@github.com:concourse/git-resource.git
    branch: master
    private_key: |
      -----BEGIN RSA PRIVATE KEY-----
      MIIEowIBAAKCAQEAtCS10/f7W7lkQaSgD/mVeaSOvSF9ql4hf/zfMwfVGgHWjj+W
      <更多文本>
      DWiJL+OFeg9kawcUL6hQ8JeXPhlImG6RTUffma9+iGQyyBMCGd1l
      -----END RSA PRIVATE KEY-----
    git_config:
    - name: core.bigFileThreshold
      value: 10m
    disable_ci_skip: true
    git_crypt_key: AEdJVEN...snip...AAA==
    https_tunnel:
      proxy_host: proxy-server.mycorp.com
      proxy_port: 3128
      proxy_user: myuser
      proxy_password: myverysecurepassword

拉取100次提交历史的仓库：

yaml
- get: source-code
  params: {depth: 100}

推送本地提交到仓库：

yaml
- get: some-other-repo
- put: source-code
  params: {repository: some-other-repo}

行为

check：检查新提交

克隆/拉取仓库，返回从指定版本开始的提交；若无版本则返回HEAD引用。含[ci skip]的提交会被忽略。

in：克隆仓库到指定引用

克隆仓库并锁定到指定引用，自动解密git-crypt仓库（若提供密钥），递归初始化子模块。额外生成.git/committer（提交者***）和.git/ref（版本引用）文件。

参数

• depth：浅克隆深度（正整数）。
• submodules：子模块策略（none/all/路径列表）。
• disable_git_lfs：是否跳过Git LFS文件获取。

out：推送到仓库

推送引用和标签到源仓库，支持变基（rebase）、合并（merge）、打标签（tag）等操作。

参数

• repository：必填，要推送的仓库路径。
• rebase/merge：非快进时的处理策略（二选一）。
• tag：标签文件路径。
• only_tag：仅推送标签。
• tag_prefix：标签前缀。
• force：强制推送。
• annotate：带注释的标签文件路径。
• notes：注释文件路径。

开发

前提条件

• golang（1.9.x+）。
• docker（17.06.x+）。

运行测试

sh
docker build -t git-resource .

集成测试说明

需添加integration-tests/ssh/test_key（私钥）和test_repo（仓库地址）文件，用于SSH访问测试仓库。

贡献

提交PR到master分支，并确保本地测试通过。