summittech/git-branches-resource

Git Branches Resource

镜像概述和主要用途

Git Branches Resource是Concourse CI/CD管道中的一种资源类型，专门用于跟踪Git仓库中存在的分支集合。它能够监控仓库分支的变化，检测新增或移除的分支，并生成包含这些变化信息的版本数据，为CI/CD流程提供分支状态的可靠依据。

核心功能和特性

• 分支变化检测：通过check操作克隆或拉取仓库，枚举所有远程分支，与现有分支集合比较，识别新增或移除的分支并生成新版本
• 版本信息输出：通过in操作生成包含当前分支状态的文件，包括完整分支列表、新增分支列表和移除分支列表
• 灵活的仓库认证：支持SSH私钥、HTTP(S)用户名密码等多种认证方式，适应不同访问控制需求
• Git配置定制：允许设置Git全局选项，满足特殊配置需求（如凭证助手等）

使用场景和适用范围

适用于Concourse CI/CD管道中需要监控Git仓库分支变化的场景，例如：

• 自动触发新分支的构建和测试流程
• 检测分支删除并执行清理操作
• 跟踪仓库分支结构变化用于报告或审计

安装

在Concourse管道配置中添加以下resource_types条目：

yaml
---
resource_types:
- name: git-branches
  type: docker-image
  source: {repository: vito/git-branches-resource}

源配置

参数说明

• uri: 必填。Git仓库的地址。
• private_key: 可选。用于拉取/推送仓库的私钥。示例：

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

• username: 可选。用于HTTP(S)认证的用户名。当仅支持HTTP/HTTPS协议且需要认证时使用。
• password: 可选。用于HTTP(S)认证的密码。
• skip_ssl_verification: 可选。通过设置GIT_SSL_NO_VERIFY=true跳过Git SSL验证。
• git_config: 可选。若指定（键值对列表，包含name和value），将配置Git全局选项。可用于设置credential.helper等选项。详见https://www.kernel.org/pub/software/scm/git/docs/git-config.html%E3%80%82

配置示例

私有仓库的资源配置：

yaml
resources:
- name: source-code
  type: git-branches
  source:
    uri: git@github.com:concourse/git-resource.git
    private_key: |
      -----BEGIN RSA PRIVATE KEY-----
      MIIEowIBAAKCAQEAtCS10/f7W7lkQaSgD/mVeaSOvSF9ql4hf/zfMwfVGgHWjj+W
      <更多文本>
      DWiJL+OFeg9kawcUL6hQ8JeXPhlImG6RTUffma9+iGQyyBMCGd1l
      -----END RSA PRIVATE KEY-----

行为

check: 检查分支集合变化

克隆仓库（若已存在则拉取更新），枚举所有远程分支，与现有分支集合比较。若有分支新增或移除，将生成包含变化信息的新版本。

in: 生成版本信息文件

根据获取的版本生成以下文件：

• branches: 包含当前所有分支的文件，每行一个分支
• added: 包含新增分支的文件，每行一个分支
• removed: 包含已移除分支的文件，每行一个分支

out: 未实现

此操作尚未实现。