sonarsource/sonarcloud-quality-gate

Bitbucket Pipelines管道：SonarCloud质量门检查

镜像概述与主要用途

该Docker镜像是Bitbucket Pipelines的专用管道（Pipe），集成了SonarCloud的质量门检查功能。主要用于在Bitbucket仓库的CI/CD流程中，在发布或部署新功能前自动检查代码的SonarCloud质量门状态，确保代码符合预设的质量标准，从而在开发流程早期发现并拦截质量不达标的代码。

核心功能与特性

• SonarCloud质量门检查：通过SonarCloud验证代码质量门状态，确保代码符合团队定义的质量指标（如代码覆盖率、漏洞数量、重复率等）。
• Bitbucket Pipelines无缝集成：作为Bitbucket Pipelines的原生管道组件，可直接嵌入CI/CD流程，无需额外复杂配置。
• 自动化质量把关：作为发布或部署阶段的前置步骤，自动化执行质量检查，减少人工干预，提升开发效率。

使用场景与适用范围

适用场景

• 代码合并至主分支前的质量验证
• 新功能发布或部署前的质量把关
• 定期代码质量监控与报告生成

适用范围

• 使用Bitbucket作为代码仓库的开发团队
• 采用Bitbucket Pipelines进行CI/CD流程管理的项目
• 已在SonarCloud注册并配置项目的代码库

使用方法与配置说明

前提条件

1. 已在SonarCloud创建项目并获取项目密钥（Project Key）和组织密钥（Organization Key）。
2. 已在Bitbucket仓库中配置SonarCloud访问令牌（通过Bitbucket仓库设置中的"Repository variables"存储，变量名建议为SONAR_TOKEN）。

基本使用流程

在Bitbucket仓库的bitbucket-pipelines.yml配置文件中，添加该管道作为CI/CD流程的一个步骤，通常置于构建或测试步骤之后、部署步骤之前。

配置参数说明

示例配置（bitbucket-pipelines.yml）

yaml
pipelines:
  default:
    - step:
        name: Build and Test
        script:
          - # 构建和测试脚本（如npm install, npm test等）
    - step:
        name: SonarCloud Quality Gate Check
        script:
          - pipe: sonarsource/sonarcloud-quality-gate:latest
            variables:
              SONAR_TOKEN: $SONAR_TOKEN
              SONAR_PROJECT_KEY: "your-sonar-project-key"
              SONAR_ORGANIZATION: "your-sonar-organization"
    - step:
        name: Deploy
        script:
          - # 部署脚本（仅在质量门检查通过后执行）

注意事项

• 确保SonarCloud项目已正确配置质量门规则（如失败条件：覆盖率<80%、存在严重漏洞等）。
• SONAR_TOKEN需具有SonarCloud项目的"浏览"权限，以获取质量门状态。
• 详细配置及高级用法可参考项目官方文档：SonarCloud Quality Gate Pipe README。