lgohr/sonarqube

concourse-sonarqube-notifier 镜像文档

镜像概述

concourse-sonarqube-notifier是一个Concourse CI资源镜像，专门用于与SonarQube集成，实现从SonarQube获取代码质量分析结果的功能。该镜像可作为Concourse流水线中的资源，帮助开发团队在CI/CD流程中自动检查SonarQube分析状态、提取关键质量指标，从而实现代码质量的自动化管控。

核心功能与特性

• Concourse资源集成：作为Concourse CI的资源类型，可直接配置到流水线中，实现与SonarQube的无缝对接
• 分析结果获取：支持获取SonarQube项目的详细分析结果，包括代码覆盖率、bug数量、漏洞、代码异味等关键指标
• 分析状态检查：能够检查SonarQube分析任务的完成状态，确保在CI流程中等待分析完成后再进行后续步骤
• 灵活配置：支持通过参数配置SonarQube连接信息、项目标识及认证方式

使用场景与适用范围

• CI/CD流水线质量控制：在Concourse CI流水线中集成SonarQube代码质量检查，确保代码提交前或部署前通过质量门禁
• 自动化报告提取：自动获取SonarQube分析报告，用于生成质量报告或触发通知
• 开发团队质量管控：适用于需要在开发流程中引入自动化代码质量检查的团队，尤其适合使用Concourse CI和SonarQube的技术栈

使用方法与配置说明

资源类型配置

在Concourse流水线的resource_types部分声明该资源类型：

yaml
resource_types:
- name: sonarqube-notifier
  type: docker-image
  source:
    repository: elgohr/concourse-sonarqube-notifier
    tag: latest  # 可指定具体版本

资源配置

在流水线的resources部分定义具体资源实例，配置SonarQube连接信息：

yaml
resources:
- name: sonarqube-results
  type: sonarqube-notifier
  source:
    sonar_host_url: https://sonarqube.example.com  # SonarQube服务器URL
    sonar_token: ((sonar_token))  # SonarQube访问令牌（建议使用Concourse变量）
    project_key: my-project-key  # SonarQube项目标识
    # 可选参数：
    # timeout: 300  # 等待分析完成的超时时间（秒），默认300
    # poll_interval: 10  # 检查分析状态的轮询间隔（秒），默认10

流水线任务中使用

在任务中通过get步骤获取SonarQube分析结果：

yaml
jobs:
- name: check-code-quality
  plan:
  - get: sonarqube-results
    trigger: true  # 可选，当SonarQube分析完成时触发
  - task: process-results
    config:
      platform: linux
      image_resource:
        type: docker-image
        source: {repository: alpine, tag: latest}
      inputs:
      - name: sonarqube-results  # 包含SonarQube分析结果的目录
      run:
        path: sh
        args:
        - -c
        - |
          cat sonarqube-results/result.json  # 分析结果JSON文件
          # 可根据结果中的指标（如bugs、vulnerabilities等）进行质量判断

环境变量与参数说明

注意事项

• 确保SonarQube令牌具有足够的权限访问指定项目
• 若SonarQube分析耗时较长，可适当调整timeout参数
• 分析结果将输出到资源目录下的result.json文件中，包含详细的质量指标