SonarQube Licensecheck 插件安装与使用手册-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00048/article/details/138149404

int32bit/notes是一个开发者社区驱动的技术笔记平台，提供多语言和技术领域的学习资源，采用Markdown格式和GitCode的版本控制与社交功能，鼓励知识共创和持续更新。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

SonarQube Licensecheck 插件安装与使用手册

sonarqube-licensecheck SonarQube Licensecheck Plugin 项目地址: https://gitcode.com/gh_mirrors/so/sonarqube-licensecheck

1. 目录结构及介绍

SonarQube Licensecheck插件的GitHub仓库遵循标准的Git仓库结构。以下是其主要目录和关键文件的简介：

src: 包含了插件的核心源代码。
- 这里会有Java类，用于实现扫描依赖项和验证许可证的功能。
docs: 文档相关的文件夹，可能存放有开发过程中的说明或指南。
CHANGELOG.md: 记录了项目的所有版本更新日志，包括新功能、修复的问题等。
LICENSE: 该项目使用的许可协议文件，明确软件的使用权限。
README.md: 主要的读我文件，包含了快速入门指导、重要特性和基本配置信息。
.editorconfig, .gitignore, prettierrc: 开发工具配置文件，确保代码风格的一致性。
package.json, pom.xml: 分别是Node.js和Maven的项目配置文件，用于构建和管理项目依赖。
docker-compose.yml: Docker环境下的配置文件，便于部署整个应用或服务。

2. 项目的启动文件介绍

本插件作为一个SonarQube的扩展，并不直接提供一个独立的应用启动文件。它的“启动”过程实际上是将编译好的jar包部署到已有的SonarQube服务器上。因此，并不存在传统意义上的启动文件。但是，从开发者的角度，若需在本地开发环境中测试或构建此插件，可能会依赖于Maven的命令（如mvn clean install）来完成构建过程。

3. 项目的配置文件介绍

SonarQube服务器端配置

在SonarQube服务器上，配置发生在SonarQube的web界面内，通过管理员权限访问“Administration”页面或通过“Configuration -> LicenseCheck”菜单进行设置。
- 全局配置：允许映射依赖名称到许可证、许可证名称到许可证、设定默认的许可证允许或禁止状态。
- 项目特定配置：可以为特定项目调整许可证允许列表。

插件部署配置

将下载的预编译jar文件放置在SonarQube安装目录下的extensions/plugins路径中，并重启SonarQube服务即可完成插件部署。
质量配置文件激活：需要手动在SonarQube的质星剖面中启用相关规则（如“License is not allowed”, “Dependency has unknown license”），以确保插件执行检查。