diff --git a/sig_rules/sig_rules.md b/Infrastructure/docs/manual/sig_rules.md similarity index 98% rename from sig_rules/sig_rules.md rename to Infrastructure/docs/manual/sig_rules.md index fb15e2314e87ef9fd4c1f65f2fb2cabe16bb3385..0d438ff627e4ebf911495bfe2b3896b8fc4419ad 100644 --- a/sig_rules/sig_rules.md +++ b/Infrastructure/docs/manual/sig_rules.md @@ -2,7 +2,7 @@ sig仓库门禁 触发方式从之前的被动触发变为主动触发,需要评论内容“sig start build” 合并方式 -代码审查需要管理员点击审查进行完成。(重要,不要点击全部测试完成。管理员确认代码侯只点击审核即可) +代码审查需要管理员点击审查进行完成。(重要,不要点击全部测试完成。管理员确认代码侯只点击审核即可) 代码测试需要待dco检测,合规检测,代码质量检测,三个检测完成后。门禁会通过测试, 提交PR待审查人员点击确认审查后会自动进行合并。 @@ -11,26 +11,34 @@ sig仓库门禁 | 评论输入命令 | 是否必选 | 使用场景 | 命令触发角色 | | ------------------ | ---------------- | ------------------------------------------------------------ | ------------ | +|sig start build | 必选 | 首次提交PR时,评论sig start build进行触发检查 |仓库管理员/PR提交者 | | check dco | 可选 | DCO检查失败时, 更新DCO信息后,人工触发检查DCO
检查通过条件:gitee账户邮箱已签署DCO+PR所有提交均包含Signed-off-by信息,检查通过 | 仓库管理员/PR提交者 | | codecheck | 可选 | 合规检查失败时, 更新合规信息后,人工触发代码合规检查测试 | 仓库管理员/PR提交者 | | qualitycheck | 可选 | 代码质量检测失败时, 按照评论修改, 人工触发代码质量测试 | 仓库管理员/PR提交者 | | build | 可选 | 进行编译检查(需要先和管理员确认配置过编译门禁) | 任何人 | | no check dco | 可选 | 引入第三方信息时,若其中包含无DCO信息,可使用此命令,跳过DCO检测,操作人需要对此次操作负责 | openharmony_sig_ci | +| submit | 可选 | 当PR各项检测通过,且opengharmony_sig_ci和仓库管理员分别测试和审查通过后,可以评论submit进行合入 |仓库管理员/PR提交者| # OpenHarmony_sig组织仓库规则说明 1.仓库不允许在线编辑文档; 2.仓库不允许任何人推送代码; -3.关闭WEB界面PR合并权限 +3.关闭WEB界面PR合并权限; 4.设置仓库所有分支为保护分支; -5.指派审查和测试人员为全部管理员,同时设置至少一人审查/测试才可合并; +5.指派审查为仓库管理员,指派测试为openharmony_sig_ci,PR通过测试和管理员审查后会自动合并,仓库管理员只能进行审查操作,不能进行测试操作,测试操作只能为openharmony_sig_ci; +6.开发者提交PR后,需要在PR下评论'sig start build'才能触发仓库门禁检查,sig start build指令会同时触发check dco、codecheck、qualitycheck检查,当需要进行其中一项检查时, +可以评论对应的命令进行单独触发检查; + + + # OpenHarmony_sig组织仓库门禁规则说明 1.门禁将对PR进行DCO检测,代码合规检测,代码质量检测以及代码编译检测,结果将在此次PR打上对应标签。 2.PR不涉及代码改动时,将不进行代码质量检测与代码编译检测。 3.代码合规检测,检测所有代码文件受否加入许可头以及版权头,检查代码文件是否有许可和版权篡改风险,检查仓库根目录下是否含有LICENSE(能让gitee正常识别到),若没有会检测pr中是否有/LICENSE,没有则检测失败。若对结果有异议可以联系管理员确认问题。 -4.代码质量检测会对代码改动进行质量测试,目前支持的语言为C++,java,JavaScript,Python,PHP,CSS,HTML,Go,TypeScript,C# +4.代码质量检测会对代码改动进行质量测试,目前支持的语言为 +C++,java,JavaScript,Python,PHP,CSS,HTML,Go,TypeScript,C# 5.DCO审核不过,不允许合并(check dco二次审核) 6.合规扫描不过,不允许合并(codecheck 二次审核) 7.质量扫描不过,不允许合并(qualitycheck 二次审核)