SCM 配置项

SCM 配置项用于表示代码仓库相关的配置信息。

配置项

字段描述备注
owner仓库拥有者这个字段不能和 org 同时配置
org仓库所属的组织这个字段不能和 owner 同时配置
scmType仓库类型目前支持 Gitlab/Github
name仓库名
baseURL仓库的根 url 地址如果你使用的是 Gitlab 仓库，你就需要配置这个字段
url仓库的 url 地址如果你配置了这个字段, 那么 org, owner, scmType, name 就不需要配置
token仓库的认证 token
branch仓库的分支如果该字段为空，对于 Github 仓库，会使用 main 分支，对于 Gitlab 仓库，会使用 master 分支

Notes:

你需要先获取仓库对应的 token。

  • 对于 Github 仓库，你可以查阅该文档 来获取 token。
  • 对于 Gitlab 官方仓库（非自建）, 可以查看该文档来创建 token (配置的 scope 只需要包含 API)。
  • 对于自建的 Gitlab 仓库，可以查看该文档 for more info。

示例

使用 url 配置 Github 仓库

YAML

  1. scm:
  2.   url: https://github.com/devstream-io/dtm-repo-scaffolding-python-flask.git
  3.   branch: main
  4.   token: TEST_TOKEN

不使用 url 配置 Github 仓库

YAML

  1. scm:
  2.   name: dtm-repo-scaffolding-python-flask
  3.   scmType: github
  4.   org: devstream-io
  5.   branch: main
  6.   token: TEST_TOKEN

使用 url 配置 Gitlab 仓库

YAML

  1. scm:
  2.   url: https://test.gitlab.com/testUser/dtm-repo-scaffolding-python-flask.git
  3.   branch: master
  4.   token: TEST_TOKEN

不使用 url 配置 Gitlab 仓库

YAML

  1. scm:
  2.   name: dtm-repo-scaffolding-python-flask
  3.   owner: testUser
  4.   baseURL: https://test.gitlab.com
  5.   branch: master
  6.   token: TEST_TOKEN
  7.   scmType: gitlab