克隆代码
此接口用于从 GitLab 指定仓库克隆项目代码。
接口说明
clone repo: 'git-repo-url'
[, checkout: 'git-checkout']
[, dir: 'directory']
[, timeout: timeout-in-minutes]
[, credentialsId: 'credentials-id']
参数说明
参数 | 类型 | 是否必填 | 说明 | 示例值 |
---|---|---|---|---|
repo | string | 是 | 要构建的工程代码在 GitLab 仓库中的项目地址,此处需要配置为 SSH 地址 | ssh://git@10.XX.XX.202:2222/admin1/app_template.git |
checkout | string | 否 | 要检出的 Git 版本,支持设置为分支或标签,默认为 master 分支 | master |
dir | string | 否 | Git 代码要克隆到的目录,默认为当前目录 | app_template |
timeout | int | 否 | 克隆 Git 仓库的超时时间,默认值为 30,单位为分钟 | 30 |
credentialsId | string | 否 | 克隆 Git 仓库所使用的 Jenkins 凭证 ID,关于凭证 ID 的更多信息请参见 新建凭据 | key-gitlab |
调用示例
clone repo: "ssh://git@10.XX.XX.XX:2222/admin1/app_template.git",
checkout: "master",
dir: "app_template",
credentialsId: "key-gitlab"