SonarQube Community Edition 使用 SonarQube CNES Report Plugin

前言

目前使用的 SonarQube 是 Community Edition 9.9 LTS，预设并不支援 PDF 报告的产製。
如果要有纸本报告只能透过 Plugin (外挂/扩充功能) 来帮忙。

最一开始找到的是 Ivan Chang 在 iThome 上所分享的 SonarQube 如何产生 PDF 分析报告 这篇文章，拜读完文章后发现 SonarQube 的版本不同 (文章内介绍的是 8.7 )，里面介绍的外挂已不支援，只能转而寻找其他外挂。

SonarQube CNES Report

SonarQube CNES Report 是由 CNES CAT LAB 所维护的报告文件产製套件，算是目前有在定期更新的第三方套件。

图片截取自 Doc: Plugin version matrix

虽然 SonarQube 的官方文件上显示它尚未支援 9.9 LTS 的版本，但其实 CAT Lab Github 上的 README 已经有清楚写明各 SonarQube 版本支援的情况，读者可以直接根据自己使用的 SonarQube 版本，选择对应的 Release jar。

使用方法

把从 Release 下载的 jar 放到 SonarQube 下的 \extensions\plugins\ 资料夹中。重启 SonarQube 服务。如果有安装成功，在画面上方的 ToolBar 的 More 按钮中，会出现 CNES Report 这个选项。点选 CNES Report 选项，会出现以下的画面，可根据需求选择产製的专案、分支、语系，以及要产出的报告类型。点选 Generate 就可以产生报告。

产出的报告会用压缩档打包，如果汇出的选项全选的话，其内容大概是这样:

以 Word 格式的报告来说，产出的格式看起来满简陋的，有需要的话可以直接编辑修改。

或者，直接修改 Administration 的 CNES Report 页籤中的 Template 路径，将客製的 Template 路径填入。但这部分我还没有实际测试过，有需要的读者可以自行试试看~

---

以上就是今天的分享，希望能帮助到有需要的人。
对于文章内容有疑问也欢迎留言一起讨论，谢谢！

本文同步发表于 HackMD