管理规则集 - 禅道DevOps解决方案手册

本篇目录

规则集使用手册

功能介绍

规则集是按照编程语言对代码扫描规则进行分组管理的集合。规则集将各类规则进行整合，方便用户针对不同语言的代码项目进行批量规则配置与管理。其中，新建的规则集支持启用 / 禁用、关联规则、编辑、删除等操作，而默认规则集为系统预设，主要用于提供基础规则配置，不支持上述操作。通过规则集，用户可以更高效地组织和运用扫描规则，提升代码扫描的针对性和效率，确保不同语言的代码都能依据合适的规则进行质量检测和问题排查。

使用场景

项目开发前期：在创建新的代码项目时，根据项目所使用的编程语言（如 PHP、Go 等），创建或选择合适的规则集，关联相关规则。例如开发一个 PHP 项目，可创建 PHP 语言规则集并关联 PHP 相关的代码规范、缺陷检测等规则，为后续代码编写和扫描奠定基础，保障代码从一开始就符合一定质量标准。
项目开发过程中：随着项目推进，代码不断增加和修改，可能需要调整规则集。比如发现现有规则无法满足对特定复杂逻辑代码的检测需求，此时可编辑规则集，关联新的适用规则；若某些规则在当前阶段不需要参与扫描，可将规则集禁用，避免不必要的检测消耗资源。
项目维护与迭代阶段：在对已上线项目进行维护或迭代开发时，通过规则集可对代码进行全面扫描复查。若有新的安全规范或代码优化要求，可对规则集进行编辑、添加规则等操作，确保项目代码始终符合最新的质量和安全要求。

一、添加规则集

点击规则集列表页面右上角的 “添加规则集” 按钮，在弹出的添加规则集界面中，依次填写：

**名称**：为规则集设置一个简洁易识别的名称，用于区分不同规则集。
**编程语言**：从下拉菜单中选择规则集所适用的一种编程语言，如 PHP、Go 等。
**描述**：可简要填写规则集的用途、包含规则特点等信息，方便后续管理和识别。

填写完成后，点击 “确定” 按钮，新的规则集即添加成功。

二、编辑规则集

在规则集列表中，找到需要编辑的新建规则集，点击其操作栏中的 “编辑” 按钮。在弹出的编辑界面中，可对规则集的名称、描述等信息进行修改。修改完成后，点击 “确定” 按钮保存更改。默认规则集无此操作功能。

三、删除规则集

对于不再需要的新建规则集，在规则集列表中，点击其操作栏中的 “删除” 按钮。系统会弹出确认删除提示框，确认无误后点击 “确定”，该规则集及其关联信息将被删除。默认规则集无此操作功能。

四、关联/移除规则

1. 关联规则

**规则集操作栏关联**：在规则集列表中，找到需要关联规则的新建规则集，点击其操作栏中的 “关联规则” 按钮。系统会弹出规则选择界面，仅展示该规则集所选编程语言对应的规则，从中勾选需要关联的规则，点击确认即可完成关联。
**规则集详情页关联**：点击规则集名称进入规则集详情页，在页面中找到 “关联规则” 按钮并点击。同样，系统会展示对应语言规则供选择，勾选确认后，所选规则将关联到该规则集。默认规则集无此操作功能。