研发规范

文章内容

研发规范功能用于检测或约束项目成员的分支创建、代码合并以及版本发布等行为，从而推动研发流程的规范化与标准化。

目前，CODING DevOps 平台提供的代码规范功能支持对代码仓库（仓库类型为 Git）配置以下类型的规范：

研发规范不仅支持以单个代码仓库为单位进行设置，也支持在项目级别指定多个代码仓库使用统一的默认规范。详情请参考 Compass——研发规范。

进入一个项目之后，在「代码仓库」模块，点击任一仓库进入其详情页面。在「设置」页面下选择「研发规范」即可为该仓库配置研发规范。

若该代码仓库为初次使用研发规范，需要先选择基准分支（通常为 master）然后进入初始化阶段。初始化可能需要花一点时间，请耐心等待。

开启研发规范功能后，页面右上角会显示「研发规范」标记，同时相关的代码仓库操作（如创建分支、提交、合并请求等）将会立即被检测是否符合规范。

开启研发规范功能之后，您还可以「开启强制规范」以强制禁止不符合规范规则的分支创建、代码推送及合并请求等操作。

必须先开启研发规范功能，才能启用强制规范。若研发规范功能关闭，强制规范不可用。

例如，若设置了开发分支的规范为 dev\/[\w-]+ 并开启了强制规范，当新建一个名为 dev001 的分支时，系统会给出正确的命名规范提示。您需输入符合规范的分支名称才能完成分支创建。

若您只开启了研发规范而没有开启强制规范，您可以顺利完成 dev001 分支创建。创建之后，系统会给出正确命名提示，且该分支被识别为「违规分支」。

若项目管理员已在「Compass」->「规范」中为新仓库默认开启规范，当首次进入当前代码仓库的「研发规范」页面时，会自动填充默认的规范配置。

参数	说明
分支类型	用于设置当前代码仓库具备共通特性的分支，如常见的开发分支、发布分支等。
检验命名	通过输入正则表达式来规范分支的命名。命名不匹配的分支将被检测出违规。

点击需要修改的命名规则输入框，填写新的正则表达式，再点击页面下方保存按钮即可生效。

如需删除某一分支类型，点击「删除」，再点击页面下方保存按钮即可生效。

分支规范配置保存之后，会立即针对现存分支和新建分支检测分支的命名。

现象： 在「分支」页面，分支被打上「违规分支」的标记，且违规项目为「分支规范」。

若该违规分支存在合并请求，在「合并请求」页面也会显示该分支存在违规情况。

原因： 该分支命名不符合分支规范。

解决方法： 根据已配置的分支规范修改分支命名。

您可以通过设置分支白名单，指定不需要纳入研发规范检测范围的分支。
在「分支白名单」配置区域，点击「新增」，选择一个或多个分支，再保存配置即可。

您可以通过配置合并规范为任一目标分支指定允许合并的源分支。

参数	说明
目标分支匹配规则	用于检查合并请求中的目标分支。
允许合并的源分支	用于检查合并请求中的源分支是否允许合并。