- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 快速入门
-
用户指南
- 代码托管(CodeArts Repo)使用流程
- 购买并授权使用Repo
- 环境和个人配置
- 访问CodeArts Repo首页
- 新建并配置CodeArts项目
- 配置Repo项目级设置
- 管理Repo成员权限
- 新建Repo代码仓库
- 迁移代码与同步仓库
- 配置Repo代码仓库设置
- 分层管理代码仓
- 设置仓库
- 克隆/下载代码仓库到本地
- 上传代码文件到Repo
- 开发协作工作流
- 提交代码到Repo并管理合并请求
- 管理代码文件
- Repo代码仓的安全管理
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- SSH Key
-
Repository
- 获取分支目录下的文件
- 获取仓库统计数据
- 获取一个仓库下特定分支的图片文件
- 修改被流水线引用的仓库状态
- 判断用户是否有仓库的管理员权限
- 设置仓库是公开状态还是私有状态
- 获取一个仓库下特定分支指定文件内容
- 获取公开示例模板列表
- 创建仓库
- 根据仓库名组名获取仓库短id,用以拼接与commitid对应提交详情页面url
- 根据组名和仓库名查询某仓库某分支对应的提交
- 查询某仓库对应的分支
- 根据仓库id查询仓库某分支对应的提交,提供更多可选参数
- 添加部署密钥
- 删除仓库部署密钥
- 获取仓库上一次的提交统计信息
- 仓库统计
- 删除仓库
- 查看仓库的创建状态
- 查询某仓库的标签列表
- 新建标签
- 查询某个仓库的详细信息
- 获取代码提交行数
- 下载仓库
- 新建保护分支
- 删除保护分支
- 批量删除保护分支
- 新建保护tag
- 删除保护tag
- 获取仓库分支列表
- 获取仓库合并请求列表
- 获取仓库合并请求详情
- 获取仓库ip白名单
- 添加仓库ip白名单
- 修改仓库ip白名单
- 删除仓库ip白名单
- 获取合并请求的变化
- 关联仓库与成员组
- 根据仓库短ID锁定仓库
- 根据仓库短ID解锁仓库
- 审核合并请求
- 获取关联工作项信息
- 根据仓库短ID和合并请求短ID获取检视人信息
- 获取变更文件列表
- Tenant
- Group
- V2Project
- RepoMember
- Commit
- File
- User
- Webhook
- Project
- v2仓库管理
- Discussion
- 应用示例
- 附录
- 历史API
-
常见问题
- 认证鉴权问题
- 成员权限问题
-
代码上传下载问题
- 从本地推送代码仓到CodeArts Repo时,报错"Error: Deny by project hooks setting 'default': message of commit"
- 用户推送二进制文件到CodeArts Repo失败
- 执行git push 命令时,报错'origin' does not appear to be a git repository...
- 在CentOS系统下使用HTTPS协议克隆代码时,报错"The requested URL returned error: 401"
- 使用git pull拉取CodeArts Repo的代码失败,报错"Merge branch 'master' of https://test.com Please Enter a commit"
- push文件时客户端提示连接断开
- fatal: refusing to merge unrelated histories
- 如何阻止涉密文件被推送到CodeArts Repo代码仓库
- 仓库迁移问题
- 合并请求问题
- Fork同步问题
- 仓库容量问题
- 常见问题汇总
- 视频帮助
- 计费说明
- 文档下载
- 通用参考
链接复制成功!
E2E设置
什么是E2E设置
CodeArts Repo支持通过“E2E设置”帮助记录每次代码合入的原因,包括开发需求、修复问题单,或者完成工作项,Repo系统将记录关联信息方便日后追溯。
在进行E2E设置前,用户请先查看约束与限制,满足E2E设置权限的用户请根据可集成系统、集成策略、自动提取单号规则进行配置,用户也可以参考E2E设置示例进行配置。
约束与限制
限制类别 |
具体限制 |
---|---|
功能限制 |
看板项目下的代码托管仓库不支持E2E设置。 |
权限限制 |
当用户角色为“项目经理”或者“项目管理员”,可以设置项目级Webhook,请参考配置项目级的Repo权限进行配置。 |
可集成系统
与CodeArts Req系统集成,使用CodeArts Req的工作项关联对应代码提交,包括代码提交、代码分支和合并请求场景。Repo系统默认设置了关联。
Repo可关联的工作项类别请参考下表。
集成策略
可选枚举值,用于限定用户在关联工作项时的选择条件。
排除状态:选中状态的工作项不可关联合并请求。例如,当前图片展示是“Scrum”项目可关联的工作项,选择“新建”,表示新建状态的工作项不可关联合并请求。
可关联类别:选中类型的工作项可以被关联。例如,如果选择Epic,表示“Epic”类型的工作项可以关联合并请求,不同类型项目可关联的工作项请参考表2。
应用分支:选中的分支将受,其他分支无限制。例如,如果正则表达式为“Branch_*”,表示所有以“Branch_”开头的分支的合并请求将遵循上述的“排除状态”和“可关联类别”设置,正则表达式规则请参考常见的正则表达式示例。
自动提取单号规则
约束与限制:
- 前缀、后缀、分隔符不能互相包含,否则提取效果不符合预期。
- 分隔符为空时,前缀和后缀不能为“;”。
- 后缀为空时,前缀和分隔符不能为“\n”。
- 前缀、分隔符、后缀为全字符匹配,不支持正则表达式。
配置步骤:
自动提取单号规则表示可以根据代码提交信息自动提取单号,请参考下表进行配置。
E2E设置示例
此示例以Scrum类型项目为例。
- 进入要配置的项目,单击“设置 > 服务集成 > E2E设置”,切换到“E2E设置”页面。
- 排除状态选择“新建”,可关联类别选择“Story”,应用分支为“Branch_*”,单号前缀为“合入需求”,分隔符为“;”,单号后缀为“\n”。
- 创建工作项。
- 新建文件。
- 进入代码托管仓库列表页,单击目标仓库名称,进入仓库。
- 在“代码”页签下,单击“新建”,在弹出的下拉框中选择“新建文件”,进入新建文件页面。
- 填写以下信息,其余参数默认即可,单击“确定”完成文件的新建。
文件名:自定义文件名称,例如:示例代码。
文件内容:自定义文件内容。
提交信息:填写E2E设置中的前缀及工作项的单号,例如:合入需求:708635317。
- 新建合并请求时提取单号。
- 切换为“合并请求”页签,单击“新建”。
- 选择源分支为“Dev”,目标分支为“master”。
此时,工作项被自动提取至该合并请求。