jetbrains/qodana-cdnet

Qodana Community for .NET Docker镜像文档

!official JetBrains project

镜像概述与主要用途

Qodana Community for .NET 是 JetBrains 官方提供的 Docker 镜像，专为 .NET 项目的代码质量分析设计。该镜像集成 Qodana 静态分析引擎，可自动化检测代码缺陷、优化代码结构、确保代码符合行业标准及团队规范。官方完整用户指南参见 Qodana for .NET 文档。

核心功能与特性

• 静态代码分析：基于 JetBrains 编译器技术，深度扫描 .NET 代码，识别语法错误、逻辑缺陷、性能瓶颈及安全漏洞。
• 多项目兼容：支持 .NET Framework、.NET Core、.NET 5+ 及 ASP.NET 等各类 .NET 项目类型。
• 自定义规则集：通过配置文件调整分析规则，适配项目特定质量需求（如排除测试文件、指定 severity 阈值）。
• CI/CD 集成：轻量级设计，可无缝嵌入 GitHub Actions、GitLab CI、Jenkins 等流程，实现自动化代码质量监控。
• 可视化报告：生成交互式 HTML 报告，包含问题分类、严重程度及修复建议，支持本地预览或集成到 CI 系统。

使用场景与适用范围

• 个人开发者：日常开发中快速自检代码质量，提前发现问题。
• 开源项目：作为贡献者提交代码前的预检工具，确保符合项目规范。
• 团队协作：集成到代码审查流程，统一团队代码风格与质量标准。
• 生产环境保障：在 CI/CD 管道中阻断低质量代码进入构建/部署环节。

使用方法与配置说明

前提条件

• 安装 Docker Engine 20.10+。
• 待分析的 .NET 项目源码（本地或可挂载路径）。

基础使用示例

1. 本地分析并预览报告

bash
docker run --rm -p 8080:8080 \
  -v <本地项目路径>:/data/project \
  jetbrains/qodana-cdnet:latest \
  --source /data/project \
  --show-report

参数说明：

• -p 8080:8080：映射容器内报告服务端口到本地。
• -v <本地项目路径>:/data/project：挂载本地项目目录到容器内 /data/project。
• --source /data/project：指定容器内待分析的源码路径。
• --show-report：启动临时 HTTP 服务，访问 http://localhost:8080 查看报告。

2. CI/CD 集成（以 GitHub Actions 为例）

在项目 .github/workflows/qodana.yml 中添加：

yaml
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-cdnet:latest
          args: --source /github/workspace

环境变量配置

高级配置（qodana.yaml）

在项目根目录创建 qodana.yaml 自定义分析行为，示例：

yaml
profile:
  name: qodana.starter  # 使用默认规则集
exclude:
  - name: "*.Tests.cs"  # 排除测试文件
  - path: "docs/"       # 排除文档目录
threshold:
  severity: medium      # 仅报告中/高严重程度问题

详细配置项参见 官方配置文档。

许可证信息

• 使用本镜像即表示同意 JetBrains 隐私政策。
• EAP 镜像：包含 30 天评估许可证，需定期拉取新镜像延续使用。
• 第三方软件：镜像包含的 Bash 等基础组件可能涉及其他许可证，详见 第三方软件声明。
• Dockerfile 源码：公开于 https://github.com/JetBrains/qodana-docker/tree/main 仓库。

支持与反馈

• 支持：
• Issue 跟踪：JetBrains YouTrack（项目代号：QD）

欢迎反馈功能建议或问题，帮助改进工具体验。