target/vela-git

镜像概述

Vela Git插件是Target官方管道自动化框架（Vela）的核心组件，专门用于在Vela流水线执行过程中克隆代码仓库至构建工作区，为后续的构建、测试、部署等流程提供源代码支持。

• 源代码：https://github.com/go-vela/vela-git
• 官方文档：https://go-vela.github.io/docs/plugins/registry/git

核心功能和特性

核心功能

• 仓库克隆：支持将远程代码仓库（Git）克隆至Vela流水线的构建工作区。
• Vela原生集成：与Vela流水线框架深度集成，无缝嵌入流水线步骤。

主要特性

• 轻量级设计，专注于代码仓库拉取核心能力。
• 支持主流Git仓库协议（HTTP/HTTPS、SSH）。
• 可配置克隆参数（分支、深度、认证信息等）。

使用场景和适用范围

适用场景

• Vela流水线初始化阶段，拉取项目源代码以执行编译、单元测试等操作。
• CI/CD流程中需要获取特定版本代码（分支、标签、提交哈希）的场景。
• 多仓库依赖项目中，同步拉取主仓库及子模块代码。

适用范围

• 基于Vela框架构建的自动化流水线环境。
• 需通过Git协议访问公开或私有代码仓库的构建场景。

使用方法和配置说明

基本使用方式

在Vela流水线配置文件（.vela.yml）中，通过steps定义插件执行步骤，配置仓库信息及克隆参数。

示例配置（Vela YAML）

yaml
steps:
  - name: clone-source-code
    image: target/vela-git
    parameters:
      repo: https://github.com/example/your-project.git  # 目标代码仓库URL（必填）
      branch: feature/new-function                       # 分支/标签/提交哈希（可选，默认仓库默认分支）
      depth: 5                                           # 克隆深度（可选，浅克隆，默认全量克隆）
      ssh_key: "<<parameters.ssh_key>>"                  # SSH密钥（私有仓库SSH协议认证，可选）
      username: "<<parameters.username>>"                # 用户名（私有仓库HTTPS协议认证，可选）
      password: "<<parameters.password>>"                # 密码/令牌（私有仓库HTTPS协议认证，可选）

关键配置参数说明

注意事项

• 网络权限：确保Vela运行环境可访问目标仓库（需开放对应网络端口，如HTTPS的443、SSH的22）。
• 私有仓库认证：私有仓库需配置正确的认证信息（ssh_key或username+password），避免克隆失败。
• 子模块支持：如需拉取仓库子模块，需额外配置submodule: true参数（具体参考官方文档）。

参考链接

• 源代码：https://github.com/go-vela/vela-git
• 官方文档：https://go-vela.github.io/docs/plugins/registry/git