同一条SonarQube规则可能在多个文件里报出问题。团队准备在本轮迭代集中处理其中几条时,可以给这些问题加上sprint-review,以后从问题列表直接筛出来。如果希望按规则的技术主题分类,例如把一类规则统一归入资源管理,则可以给规则加标签。两处标签会在问题创建时发生关联,但后续调整的对象不同。
一、SonarQube问题标签怎么添加
在SonarQube Server的问题列表和详情页中,都可以管理单条问题的标签。多条问题需要归入同一处理批次时,可以先筛选,再批量添加。
1、给单条问题添加或移除标签
①、进入目标项目,打开【Issues】,用文件、规则或现有筛选条件找到需要标记的问题。
②、在问题卡片或详情页找到【Tags】区域,点击加号,打开标签选择框。
③、在搜索框中输入【sprint-review】。已有同名标签时,勾选该项。没有同名标签时,选择带加号的同名选项,创建并添加标签。
④、需要移除标签时,回到【Tags】取消勾选对应项。点击弹窗外部关闭选择框,再核对问题卡片上的标签。
手动添加的标签适合记录本条问题的处理安排。比如,同一条规则报出了五个问题,其中两个已分配到本轮迭代,就只给这两个加标签,剩下三个按原计划处理。
2、先筛选,再给多条问题打标签
批量处理前,先看清列表里的记录是否属于同一批工作。特别是从全局问题页进入时,可以先按项目收窄范围。
①、在【Issues】中按当前任务筛选项目、规则或文件,再检查候选问题。
②、逐条勾选要处理的记录,打开【Bulk change】。使用列表顶部的全选复选框时,取消勾选本轮不处理的问题。
③、在批量操作中选择添加标签,填写或选择【sprint-review】,提交变更。
④、回到问题列表,用【Tags】筛选该标签,抽查刚才选中的问题是否都已出现。
二、SonarQube问题标签与规则标签有何关系
问题由规则触发。创建问题时,它会继承对应规则的标签。创建之后,每条问题的标签可以独立编辑,规则标签与已有问题标签不会持续同步。
1、查看一条问题对应的规则标签
①、在【Issues】打开问题详情,记下触发它的规则名称或【规则键】。
②、切换到【Rules】,查找该规则,查看规则详情中的【Tags】。
③、回到问题详情,比较两处标签。需要判断某个标签是否为后加时,结合问题产生时间和团队的标签变更记录核对。
两边的标签不同很常见。规则可能在问题创建后才补了分类,也可能是项目成员在问题上增加了处理标签,或移除了某个继承来的标签。当前两处列表只能用来比较现状,单凭同名或缺项,无法确定某个标签最初从哪里来。
2、按规则分类时修改规则标签
规则标签适合表达这条检查的长期主题。如果要让以后由该规则新建的问题带上某项分类,可以从规则本身着手。
①、使用拥有【Administer Quality Profiles】权限的账号进入【Rules】,找到要分类的规则。
②、点击规则详情【Tags】中的加号,打开【Edit Tags】。搜索已有标签,或输入新名称并选择带加号的同名项。
③、核对规则上的标签,再在后续分析产生的【新建问题】中抽查继承结果。需要补标历史问题时,到问题列表单独处理。
3、只调整个别问题时修改问题标签
①、在【Issues】里打开需要单独跟踪的问题,添加本轮使用的标签,或取消勾选不适用的继承标签。
②、回到【Rules】核对对应规则的标签,再查看同规则下的其他问题,确认此次分类落在预期的记录上。
三、SonarQube规则标签调整后怎么整理历史问题
给规则补了分类后,直接用新标签筛选,可能只看到后续新建的问题。希望历史记录也纳入同一分类时,可以按规则先找全候选问题,再决定哪些要补标。
1、给确实属于同一类的历史问题补标
①、在【Issues】里按对应规则筛选,并核对项目、分支和问题状态。先用规则找候选记录,以免漏掉尚未带有新标签的问题。
②、打开几条候选记录,核对【Tags】,排除有意移除该标签或需要单独跟踪的问题。
③、选中本轮要补标的记录,通过【Bulk change】添加目标标签,再用【Tags】筛选确认结果。
重新分析后仍被识别为同一条历史问题的记录,仍应按已有问题看待。整理历史分类时,可以把规则变更日期和补标范围一并记下来。之后有人追问某个项目为何还查不到这类问题,就有具体范围可查。
2、给技术分类和处理批次起不同的名字
同一个词如果既用来标记规则主题,又用来记录处理进度,筛选出来的列表就容易混在一起。起名时可以让读者一眼看出标签是用来描述问题类型,还是用来安排当前工作。
①、在团队的【标签约定】里,分别列出规则主题和问题跟踪用的命名示例,例如【resource-management】和【sprint-review】。
②、在【Issues】中用处理标签定位待跟踪记录,再查看每条问题的状态。处理完成后,按团队约定更新状态,并决定是否保留本轮标签。
总结
规则标签适合长期分类,问题标签更方便记录某一条问题的处理安排。两者的联系发生在问题创建时,历史记录是否需要补标,要看团队希望筛选结果覆盖哪一段时间。如果一个标签会用于例会或迭代统计,提前约定它的含义和使用范围,往往比事后清理一长串近义标签省事。