DevOps 进行时之最佳实践分享：代码合规检查配置

FYIRH

/ `% p! y4 d# I" X

0 y7 i3 l( I* ~DevOps 推广及改进过程中，组织级准备了 DevOps 流水线套餐供项目组使用，pipeline 包含了代码合规检查任务，该任务搭配质量门禁任务进行指标及增量控制，质量任务中 圈复杂度平均值、圈复杂度最大值、重复率百分比等几个值，由项目组自行定义。

$ c! J- b: d$ Y8 i, Q) T/ G根据近期实践结果，梳理了如下详细的代码合规检查任务配置实践。

2 o6 `- `- t! r# B

• 选中流水线套餐中的代码合规检查任务
  
  * [* O: d2 Y1 o, D

( W6 Y+ T- J9 S

• 生成类型
  
  

支持 Maven、ant、Msbuild，Java 代码请选择 Maven，下述相关以 Maven 类型为例。

• 选择 DevOps 规则集
  
  

# T  c4 F& D9 ?2 W" B& i1 g% p
$ F0 ?$ k$ z+ E1 G

• 确认 POM 文件路径，在 Maven POM 文件中填入正确的路径及文件名（可引用，可直接指定）
  
  

1）引用：

6 ?2 `* L9 k! M5 N) }1 U

* U  [# t3 n+ D; H4 _# C* s8 i

2）直接指定：

8 w; H5 M7 x# u  x- ^0 [

0 q  ]' p$ t4 i4 x2 b1 f: |

1 t8 p6 u, o, r4 Z/ j: k& o

• 指定 jdk 类型(sun或ibm)，jdk版本(1.5-1.8)。
  
  0 f0 |, q2 o6 g# g" @6 o- Y" V9 z

• 是否同步
  
  9 X' W" r; o. |1 T+ T4 n; `8 u

1）true：检查完成没有增量才执行下一个任务

+ p1 d! S" Z2 N3 d

3 D9 S. t# T7 a4 x# G$ i' V6 c, D

2）false：只将检查消息发送给代码合规检查服务，即可执行 pipeline 的下一个任务

• 是否增量通知
  
  9 F6 e$ F/ ~7 r! `7 [6 H

1）勾选，进行增量控制，如有增量且发送邮件，代码合规检查任务失败；

6 N" u  f- R5 v* u

) W1 M$ h, Y& A9 I7 U8 Q1 R& n8 j1、收件人地址，可选。

% B* |$ j; y6 o; `* q# b

! w  C* s' e0 ]2 x2、是否给提交人发邮件，默认yes，发送。

3、用于比较的buildId，默认-1，将此次报告与上次运行成功（pipeline所有任务都成功）的buildid对应的代码合规检查报告进行比对，如有新增，代码合规检查返回1，任务失败；支持输入指定的buildid，该buildid需要成功生成了报告（无需pipeline所有任务都成功），供异常情况处理时或熟练使用代码合规检查任务后使用，日常使用，建议保持值为-1。

2 z* ~& ^1 E$ g0 s, O" R

4、目标分支名称，被合并的分支名称，供邮件正文中作为标记字段使用，可以不填！

7 F# O! |0 ^5 X/ ]7 s8 I2）不勾选，不启动增量控制，如有增量，不影响代码合规检查任务成功。

! ]4 U! i' g0 z1 v- E

! U5 T" B9 }0 ?& t% b* G
: s  @9 _# S! A+ p" J

• 控制选项、环境变量、输出变量按默认即可，可按需修改。
  

/ W$ O4 X1 U% I) m% j对于行内非 DevOps 流水线套餐定制的 pipeline 如需添加代码合规检查任务，也可照上述说明进行配置（对于规则集选用，项目组可视需求进行选择）。(转自张金叶）
/ S, ?' R) [) b/ p6 A6 ]5 H

9 |( l! a% V7 {0 r
/ p+ W  x  M% r. U2 C
& e' r/ e" o" K9 D2 y



4 X* |2 g5 x2 \" \$ K# @0 ]* a
/ P- u5 ~+ h  V2 R7 |( h1 f


9 C  [; u7 b- }; ]/ o& J