Qodana Go 代码质量分析工具 Docker 镜像文档

!official JetBrains project

1. 镜像概述与主要用途

Qodana Go Docker 镜像是 JetBrains 官方提供的代码质量分析工具，专为 Go 语言项目设计。该镜像集成了 JetBrains 成熟的静态代码分析引擎，可自动化检测 Go 代码中的质量问题、风格违规、潜在错误及安全隐患，帮助开发团队提升代码质量、规范开发流程并降低维护成本。

2. 核心功能与特性

• 深度静态代码分析：基于 JetBrains IDE 同款代码检查规则，精准识别 Go 语法错误、未使用变量、类型不匹配等问题
• Go 语言最佳实践检查：内置对 Go 语言规范（如 go fmt、go vet）及行业最佳实践的自动校验
• 详细报告生成：支持输出 HTML、JSON 等格式的分析报告，包含问题分类、严重级别及修复建议
• CI/CD 无缝集成：可直接嵌入 Jenkins、GitHub Actions、GitLab CI 等持续集成流程，实现代码质量自动化管控
• 可定制化规则：支持通过配置文件自定义检查规则，适配团队特定的代码规范

3. 使用场景与适用范围

• Go 项目开发流程：在本地开发或代码审查阶段快速定位问题，减少低级错误提交
• 持续集成/部署 (CI/CD)：在构建流程中自动触发代码质量检查，阻断不合格代码进入后续环节
• 大型项目质量监控：长期跟踪代码质量趋势，量化评估重构效果及团队开发规范执行情况
• 开源项目维护：为贡献者提供统一的代码质量标准，降低人工审核成本

4. 使用方法与配置说明

4.1 前提条件

• 安装 Docker Engine（20.10.0+ 版本）
• 本地或 CI 环境中需挂载 Go 项目源码目录

4.2 快速使用（docker run 命令）

docker run --rm -v <本地项目路径>:/data/project -v <报告输出路径>:/data/results jetbrains/qodana-go --show-report

参数说明：

• -v <本地项目路径>:/data/project：挂载本地 Go 项目目录至容器内分析路径
• -v <报告输出路径>:/data/results：指定分析报告的本地输出目录
• --show-report：分析完成后在容器内启动临时 Web 服务，可通过 http://localhost:8080 查看报告

4.3 详细配置与高级用法

4.3.1 自定义检查规则

通过项目根目录下的 qodana.yaml 文件配置检查规则（示例）：

profile:
  name: qodana.starter
  path: .qodana/profile.xml  # 自定义规则文件路径
exclude:
  - name: UnusedVariable  # 排除特定检查项
  - path: ./vendor/       # 排除 vendor 目录

4.3.2 CI/CD 集成示例（GitHub Actions）

在 .github/workflows/qodana.yml 中添加以下配置：

name: Qodana
on: [push, pull_request]
jobs:
  qodana:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run Qodana
        uses: JetBrains/qodana-action@v2023.3
        with:
          image: jetbrains/qodana-go
          args: --results-dir=/github/workspace/qodana-report

4.4 用户指南

完整使用说明请参考 官方用户指南。

5. 许可证信息

使用 Qodana Docker 镜像即表示您同意 JetBrains 隐私政策。

• 评估许可：EAP（早期访问版）镜像包含 30 天有效期的评估许可，需定期拉取新版本镜像以延续使用。
• 第三方软件许可：镜像中包含的第三方软件（如 Bash 等基础依赖）可能受其他许可证约束，详见 JetBrains 第三方软件许可信息。

镜像构建源码（Dockerfile）开源托管于 JetBrains/qodana-docker 仓库。

6. 联系与反馈

如有使用问题或功能建议，可通过以下方式联系 JetBrains 团队：

• 邮箱：***
• 问题跟踪：JetBrains YouTrack（项目代号：QD）

我们欢迎您对现有功能的反馈及新功能需求建议。