flexys/git-multibranch-resource

Git多分支资源

这是Concourse CI的资源类型镜像，用于跟踪Git仓库的提交记录，支持多分支模式，可灵活配置私有仓库、路径过滤、Redis存储等功能，帮助用户在CI/CD流程中高效管理代码版本与分支变化。

核心功能

• 跟踪Git仓库的多个分支提交，支持正则表达式匹配分支
• 支持私有仓库访问（通过SSH私钥）
• 路径过滤：仅关注指定文件/目录的变更，或忽略特定路径
• 浅克隆：限制克隆深度以减少数据传输
• Redis存储：用Redis保存多分支历史引用，避免分支引用混乱
• 提交过滤：忽略含[ci skip]的提交
• 推送功能：将本地仓库提交推送到远程，并支持标签管理

使用场景

1. CI/CD流水线中自动检测多分支的代码变更，触发构建或部署
2. 管理私有Git仓库的代码同步，确保流水线安全访问
3. 过滤特定文件（如文档、配置）的变更，减少不必要的构建
4. 多分支项目中，用Redis存储历史引用，保持分支管理清晰

配置说明

源配置（Source Configuration）

• uri：必填，Git仓库地址（如git@github.com:org/repo.git）
• branch：必填，默认跟踪的分支（如master）
• private_key：可选，访问私有仓库的SSH私钥（需以-----BEGIN RSA PRIVATE KEY-----开头）
• paths：可选，列表类型，仅关注指定路径的变更（如["src/**/*.js", "docs/"]）
• ignore_paths：可选，列表类型，忽略指定路径的变更
• skip_ssl_verification：可选，布尔值，跳过Git SSL验证（设置为true时生效）
• branches：可选，正则表达式，匹配需要跟踪的分支（开启多分支模式）
• ignore_branches：可选，正则表达式，忽略匹配的分支（需与branches配合使用）
• redis：可选，Redis配置（用于存储多分支历史）
  • host：必填，Redis主机地址
  • password：可选，Redis密码
  • prefix：可选，键前缀（区分不同流水线）
  • db_number：可选，Redis数据库编号（默认0）

使用示例

私有仓库资源配置

yaml
resource_types:
- name: git-multibranch
  type: docker-image
  source:
    repository: flexys/git-multibranch-resource

resources:
- name: source-code
  type: git-multibranch
  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-----

浅克隆（仅拉取最近100次提交）

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

推送本地仓库到远程

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

跟踪所有分支，忽略master和deploy分支

yaml
resources:
- name: my-repo
  type: git-multibranch
  source:
    uri: git@github.com:my-org/my-repo.git
    branches: '.*'
    ignore_branches: '(master|deploy)'

行为说明

check：检测新提交

克隆（或拉取）仓库，返回指定版本后的所有新提交；若无版本则返回HEAD引用。含[ci skip]的提交会被忽略。

in：克隆指定版本的仓库

将仓库克隆到目标路径，并锁定到指定引用，返回该引用作为版本。递归初始化并更新子模块。

参数

• depth：可选，正整数，浅克隆深度
• submodules：可选，取值none（不获取子模块）、all（获取所有子模块）或子模块路径列表

out：推送至仓库

将本地仓库的引用推送到远程仓库的指定分支，同时推送所有标签。若无法快进且未设置rebase则推送失败。

参数

• repository：必填，待推送的本地仓库路径
• rebase：可选，布尔值，若推送失败则尝试重新基地并继续推送
• tag：可选，标签文件名路径（HEAD将被标记）
• only_tag：可选，布尔值，仅推送标签
• tag_prefix：可选，标签前缀（如v，用于版本号前加v）