SonarQube Stash插件使用教程

SonarQube Stash插件使用教程

sonar-stash Stash (BitBucket) plugin, a pull-request decorator which allows to integrate SonarQube violations directly into your pull-request 项目地址: https://gitcode.com/gh_mirrors/so/sonar-stash

---

项目介绍

SonarQube Stash插件是一款用于BitBucket（原名Stash）的拉取请求装饰器，它能够将SonarQube分析出的代码质量问题直接集成到你的拉取请求中。该工具非常适合希望在代码审查阶段就发现并解决问题的开发团队。自从SonarQube版本7.7起，由于不再支持该插件所依赖的扩展点，因此，此插件仅兼容SonarQube 6.7（LTS）和7.6，并且不适用于更高的版本。

项目快速启动

环境准备

• Git客户端
• Maven 3.0.5或更高版本
• JDK 1.8+
• SonarQube 6.7（LTS）或7.6
• BitBucket Server REST API v1.0（对应BitBucket版本3.x或4.x）

构建插件

首先，从GitHub克隆项目：

git clone https://github.com/AmadeusITGroup/sonar-stash.git

然后，在项目根目录下执行以下命令来构建jar文件：

mvn clean package

部署插件

将生成的target/sonar-stash-plugin-版本号.jar复制到SonarQube服务器的插件目录，并重启服务：

cp target/sonar-stash-plugin-1.0.jar $SONARQUBE_HOME/extensions/plugins

配置SonarQube

登录SonarQube管理界面，找到Stash的设置页面配置以下信息：

• Stash基础URL: 你的BitBucket服务器地址。
• Stash基础用户: 推送违规信息至拉取请求的用户账号，需有REPO_READ权限。
• 其他配置项: 包括密码、用户Slug、问题阈值等，具体参照官方文档进行适当设置。

分析激活

在SonarQube分析时，通过额外参数启用插件，例如使用SonarRunner时：

sonar-runner -Dsonar.analysis.mode=issues \
             -Dsonar.stash.notification=true \
             -Dsonar.stash.project=项目名称 \
             -Dsonar.stash.repository=仓库名称 \
             -Dsonar.stash.pullrequest.id=拉取请求ID \
             -Dsonar.stash.password=密码

记得替换相应的项目、仓库及拉取请求ID等信息。

应用案例和最佳实践

在持续集成流程中，集成SonarQube Stash插件能极大提升代码质量控制效率。最佳实践是将插件的运行自动化，通常是作为CI脚本的一部分，确保每次提交后都能立即反馈代码质量状态。这可以实现及时的问题修复，减少后期合并冲突和代码重构的工作量。

典型生态项目

虽然这个特定的插件专注于BitBucket与SonarQube的集成，对于更广泛的生态系统，考虑与其他持续集成工具如Jenkins、GitLab CI/CD的结合使用，可以进一步增强自动化测试和部署的流程。特别是，如果组织迁移到了Atlassian的Bitbucket Cloud，可能需要寻找与之相适应的新解决方案，比如考虑SonarCloud与Bitbucket的集成方式，或者探索社区维护的替代插件来维持类似功能。

---

以上就是SonarQube Stash插件的基本使用教程，通过这样的步骤，您应该能成功地在其支持的环境内设置并利用这一强大的代码质量监控工具。

sonar-stash Stash (BitBucket) plugin, a pull-request decorator which allows to integrate SonarQube violations directly into your pull-request 项目地址: https://gitcode.com/gh_mirrors/so/sonar-stash