moredhel/git-resource

Git Resource镜像

该镜像用于跟踪Git仓库中的提交，支持在CI/CD流水线中获取（get）和推送（put）代码，提供丰富的配置选项以满足不同场景需求。

源配置

• uri：必填。仓库的位置。
• branch：要跟踪的分支。仅用于get步骤时可选，但用于put步骤时必填。若get时未设置，使用仓库默认分支（通常为master）。
• private_key：可选。拉取/推送时使用的私钥。示例：

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

• forward_agent：可选。设为true时启用SSH的ForwardAgent选项，适用于代理/跳转主机场景，默认false。
• username：可选。HTTP(S)认证的用户名，用于拉取/推送。
• password：可选。HTTP(S)认证的密码。
• paths：可选。指定文件路径的 glob 模式列表，仅当这些文件变化时才触发新版本检测。
• ignore_paths：可选。与paths相反，忽略指定文件的变化。
• skip_ssl_verification：可选。跳过Git SSL验证，设置GIT_SSL_NO_VERIFY=true。
• tag_filter：可选。仅检测匹配glob模式标签的提交。
• git_config：可选。Git全局配置项列表（name和value对），如credential.helper。
• disable_ci_skip：可选。允许检测包含[ci skip]或[skip ci]的提交。
• commit_verification_keys：可选。用于验证提交的GPG公钥数组。
• commit_verification_key_ids：可选。用于验证提交的GPG公钥ID数组，将从gpg_keyserver获取。
• gpg_keyserver：可选。GPG密钥服务器，默认hkp:///keys.gnupg.net/。
• git_crypt_key：可选。Base64编码的git-crypt密钥，用于解密仓库。
• git_crypt_gpg_key：可选。git-crypt的GPG密钥，可直接导入。
• https_tunnel：可选。HTTPS代理隧道配置，包含proxy_host（必填）、proxy_port（必填）、proxy_user（可选）、proxy_password（可选）。
• commit_filter：可选。提交消息过滤规则，包含exclude（跳过含指定字符串的提交）和include（仅保留含指定字符串的提交）。

配置示例

私有仓库带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密钥，自动解密仓库。

参数

• depth：可选。正整数时进行浅克隆，自动加深直到找到指定版本。
• submodules：可选。none不获取子模块；列表指定子模块路径；默认或all获取所有子模块。
• submodule_recursive：可选。是否递归获取子模块，默认true。
• submodule_remote：可选。是否使用.gitmodules中指定的远程分支，默认false。
• disable_git_lfs：可选。是否禁用Git LFS，默认false。
• clean_tags：可选。是否删除所有传入标签，默认false。
• short_ref_format：可选。.git/short_ref的格式，默认%s。

GPG签名验证

若配置了commit_verification_keys或commit_verification_key_ids，会验证提交是否由指定密钥签名，否则报错。

生成的附加文件

• .git/committer：提交者***，用于失败通知。
• .git/ref：检出的版本引用（SHA或标签）。
• .git/short_ref：短引用（前7字符）。
• .git/commit_message：提交消息。

out：推送至仓库

将检出的引用推送到源仓库的指定分支，同时推送所有标签。若非快进且未设置rebase，推送失败。

参数

• repository：必填。要推送的仓库路径。
• rebase：可选。非快进时尝试重新基址并推送。
• merge：可选。非快进时尝试合并远程分支后推送，与rebase互斥。
• returning：可选。merge时返回合并后的提交或原提交，默认merged。
• tag：可选。文件路径，内容为标签名，用于标记HEAD。
• only_tag：可选。仅推送标签，默认false。
• tag_prefix：可选。标签前缀（如v）。
• force：可选。强制推送分支，默认false。
• annotate：可选。文件路径，内容为注释消息，用于创建带注释的标签。
• notes：可选。文件路径，内容为笔记，添加到HEAD的refs/notes/commits。

使用场景

适用于Concourse等CI/CD工具中，作为代码获取和推送的资源，支持私有仓库、子模块、加密仓库等场景，满足企业级流水线的代码管理需求。

配置说明

根据实际需求配置源参数（如私钥、分支、代理等），并在流水线中通过get和put步骤使用该资源，实现代码的自动化拉取和推送。