patsys/git-resource

Git Resource镜像概述

该镜像用于跟踪Git仓库中的提交记录，支持在CI/CD流水线（如Concourse）中执行代码拉取（get）、推送（put）操作，并提供丰富的配置选项以满足不同场景需求。

核心功能

1. 提交跟踪: 检测仓库新提交，可忽略含[ci skip]/[skip ci]的提交（支持禁用该规则）。
2. 代码拉取: 克隆指定分支代码，支持浅克隆、子模块拉取、Git LFS、Git-Crypt解密等。
3. 代码推送: 推送本地提交到远程仓库，支持强制推送、标签管理、合并/变基操作。
4. 安全验证: 通过GPG公钥或密钥ID验证提交合法性。
5. 代理支持: 配置HTTPS代理隧道执行SSH-based Git命令。

使用场景

• CI/CD流水线自动拉取代码触发构建。
• 推送流水线产物或标签到Git仓库。
• 管理加密或需签名验证的代码仓库。
• 透过企业代理访问Git仓库。

配置说明

源配置（Source Configuration）

主要配置项：

• uri: 必选，仓库地址。
• branch: 可选（put步骤必选），跟踪分支，默认仓库默认分支。
• private_key: 可选，SSH认证私钥。
• username/password: 可选，HTTP(S)认证凭据。
• paths/ignore_paths: 可选，需跟踪/忽略的文件路径（glob模式）。
• git_crypt_key: 可选，Base64编码的Git-Crypt解密密钥。
• https_tunnel: 可选，代理隧道配置（含proxy_host/proxy_port等子项）。

操作示例

私有仓库+代理配置

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: 检测仓库新提交，返回版本信息。
• in: 克隆指定版本代码，生成.git/committer（提交者***）、.git/ref（版本引用）等辅助文件。
• out: 推送代码到远程仓库，支持标签、合并/变基等操作。 ===END===