codacy/codacy-credo

Codacy Credo 引擎 Docker 镜像

概述

Codacy Credo 引擎 Docker 镜像是 Codacy 代码质量平台（[***] Elixir 静态代码分析工具 Credo 构建。该镜像旨在集成于 Codacy 代码质量检测流程，对 Elixir 项目代码进行自动化静态分析，帮助开发团队识别代码风格不一致、潜在错误、未使用代码等质量问题。

源码地址：https://github.com/codacy/codacy-credo
构建状态：[***]

核心功能特性

• Credo 静态分析集成：内置 Elixir 静态代码分析工具 Credo，支持检测代码风格规范、潜在逻辑错误、性能隐患、未使用变量/函数等常见代码质量问题。
• Codacy 平台适配：遵循 Codacy 引擎接口规范，可无缝接入 Codacy 代码质量检测流程，自动接收分析任务并返回标准化结果。
• 持续构建支持：通过 CircleCI 持续集成 pipeline 自动构建（构建链接），确保镜像版本与 Credo 工具及 Codacy 平台更新同步。

使用场景

• Codacy 平台 Elixir 项目检测：作为 Codacy 平台的内置引擎，对托管于 Codacy 的 Elixir 代码仓库进行自动化静态分析，生成代码质量报告。
• CI/CD 流程集成：在开发团队的 CI/CD 流程中，通过 Codacy 平台触发该引擎执行，在代码提交或 PR 阶段自动运行静态分析，提前阻断低质量代码合并。

使用方法

该镜像主要作为 Codacy 平台的内部组件运行，无需用户手动部署。Codacy 平台会根据代码分析任务自动拉取并执行镜像。如需本地开发或自定义集成，可参考以下步骤：

前提条件

• 安装 Docker 环境
• （可选）Codacy 平台访问权限或自定义集成所需的 API 密钥

本地开发测试（示例）

由于镜像需遵循 Codacy 引擎协议，具体运行参数需参考源码文档。以下为简化示例（实际参数需根据引擎规范调整）：

bash
# 挂载本地 Elixir 项目目录并运行分析（仅供开发测试）
docker run --rm -v /local/path/to/elixir/project:/code codacy/credo:latest analyze /code

配置说明

分析行为可通过以下方式自定义：

1. 项目级配置（推荐）：在待分析的 Elixir 项目根目录中添加 .credo.exs 文件，自定义分析规则、排除路径、阈值等（配置方法参考 Credo 官方文档）。
2. 平台级配置：在 Codacy 项目设置中调整静态分析规则开关、严重程度阈值等参数，平台会将配置传递给引擎。

源码与构建信息

• 源码仓库：https://github.com/codacy/codacy-credo%EF%BC%88%E5%8C%85%E5%90%AB%E8%AF%A6%E7%BB%86%E5%BC%80%E5%8F%91%E6%96%87%E6%A1%A3%E3%80%81%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97%E5%8F%8A%E5%BC%95%E6%93%8E%E5%8D%8F%E8%AE%AE%E8%AF%B4%E6%98%8E%EF%BC%89
• 构建流水线：[***]