justusbunsi/gitea-sonarqube-bot

Gitea SonarQube Bot 镜像文档

1. 镜像概述

1.1 主要用途

Gitea SonarQube Bot 是一个连接 Gitea 代码仓库与 SonarQube 代码质量分析平台的机器人服务。其核心功能是接收来自 SonarQube 和 Gitea 的事件消息，自动将 SonarQube 分析结果同步至 Gitea 拉取请求（Pull Request）中，帮助开发者在 PR 流程中直接获取代码质量反馈，解决 SonarQube 原生不支持 Gitea ALM 集成的问题。

2. 核心功能与特性

• 双向消息接收：同时监听 SonarQube 的分析完成事件和 Gitea 的 PR 事件；
• PR 结果装饰：在 Gitea 拉取请求中自动添加 SonarQube 分析结果评论，包含代码质量指标（如漏洞、异味、覆盖率等）；
• 状态同步：更新 Gitea PR 状态，直观展示 SonarQube 分析结论（通过/不通过）；
• 生产力提升：消除开发者在 Gitea 与 SonarQube 之间的平台切换成本，实现质量反馈流程自动化。

3. 使用场景与适用范围

3.1 适用场景

• 开发团队使用 Gitea 作为代码托管平台；
• 使用 SonarQube 进行代码质量监控与分析；
• 需要在 PR 评审流程中集成代码质量检查结果，缩短反馈周期。

3.2 适用范围

• 中小型开发团队的 Git 工作流；
• 基于 Gitea + SonarQube 技术栈的 DevOps 流程；
• 需要自动化代码质量门禁（Quality Gate）的项目。

4. 使用方法与配置说明

4.1 环境要求

• Docker 环境（20.10+ 版本）；
• 可访问的 Gitea 实例（1.14+ 版本）及管理员权限 API 令牌；
• 可访问的 SonarQube 实例（8.0+ 版本）及分析权限 API 令牌；
• 网络互通：Bot 服务需同时能访问 Gitea 和 SonarQube 的 API 接口。

4.2 部署方式

4.2.1 Docker Run 命令示例

bash
docker run -d \
  --name gitea-sonarqube-bot \
  -p 8080:8080 \
  -e GITEA_BASE_URL="https://gitea.example.com" \
  -e GITEA_TOKEN="your-gitea-api-token" \
  -e SONARQUBE_BASE_URL="https://sonarqube.example.com" \
  -e SONARQUBE_TOKEN="your-sonarqube-api-token" \
  -e BOT_LISTEN_PORT=8080 \
  docker.xuanyuan.run/justusbunsi/gitea-sonarqube-bot:latest

4.2.2 Docker Compose 配置示例

yaml
version: '3.8'
services:
  gitea-sonarqube-bot:
    image: docker.xuanyuan.run/justusbunsi/gitea-sonarqube-bot:latest
    container_name: gitea-sonarqube-bot
    restart: always
    ports:
      - "8080:8080"
    environment:
      - GITEA_BASE_URL=https://gitea.example.com  # Gitea 实例基础 URL
      - GITEA_TOKEN=your-gitea-api-token          # Gitea API 令牌（需有 PR 评论/状态更新权限）
      - SONARQUBE_BASE_URL=https://sonarqube.example.com  # SonarQube 实例基础 URL
      - SONARQUBE_TOKEN=your-sonarqube-api-token  # SonarQube API 令牌（需有项目分析结果访问权限）
      - BOT_LISTEN_PORT=8080                      # Bot 服务监听端口
      - LOG_LEVEL=info                            # 日志级别（可选：debug/info/warn/error）
    networks:
      - devops-network  # 确保与 Gitea/SonarQube 在同一网络或可互通

networks:
  devops-network:
    external: true  # 引用现有网络（需提前创建）

4.3 配置参数说明

5. 变更日志

完整版本变更记录请参考 https://codeberg.org/justusbunsi/gitea-sonarqube-bot/src/branch/main/CHANGELOG.md%E3%80%82

6. 效果预览

6.1 PR 评论展示

!https://codeberg.org/justusbunsi/gitea-sonarqube-bot/raw/branch/main/docs/slideshow/comment.png

6.2 PR 状态同步

!https://codeberg.org/justusbunsi/gitea-sonarqube-bot/raw/branch/main/docs/slideshow/status.png

7. 扩展说明

更多高级配置（如自定义评论模板、事件过滤规则等）请参考 https://codeberg.org/justusbunsi/gitea-sonarqube-bot#installation%E3%80%82