nukengprodservice/danger

NUK Engineering Productivity 工具镜像

镜像概述

本镜像由NUK工程生产力团队开发维护，集成Danger工具及相关依赖，旨在为开发团队提供开箱即用的工程效率提升解决方案。通过自动化代码审查、PR（Pull Request）检查等功能，实现开发流程的自动化与标准化，减少人工操作成本，提升代码质量与团队协作效率。

核心功能与特性

• Danger工具集成：内置Danger运行环境，支持执行Dangerfile定义的自动化检查规则
• 多平台适配：兼容GitHub、GitLab、Bitbucket等主流代码托管平台的API交互
• 自定义规则支持：允许通过挂载Dangerfile实现团队定制化的代码审查逻辑
• CI/CD无缝集成：可直接嵌入CI/CD流水线，实现PR提交时自动触发检查流程
• 轻量级设计：基于精简基础镜像构建，减少资源占用，提升容器启动与运行效率

使用场景与适用范围

• 开发团队代码审查：自动化检查PR中的代码规范、测试覆盖率、文档更新等内容，生成结构化审查报告
• 代码质量门禁：在CI流程中设置检查阈值，如发现未解决的代码问题则阻断构建流程
• 团队规范执行：通过统一的Danger规则，确保团队成员遵循一致的开发规范与最佳实践
• 开源项目协作：简化外部贡献者PR的初步审查流程，降低项目维护者的人工审核成本

使用方法与配置说明

基本使用（Docker Run）

bash
docker run --rm \
  -e DANGER_GITHUB_API_TOKEN=<your_github_token> \
  -v $(pwd):/app \
  nuk-engineering-productivity/danger-repo:latest \
  danger pr https://github.com/your-org/your-repo/pull/123

Docker Compose配置示例

yaml
version: '3'
services:
  danger-check:
    image: nuk-engineering-productivity/danger-repo:latest
    environment:
      - DANGER_GITHUB_API_TOKEN=${DANGER_GITHUB_API_TOKEN}
    volumes:
      - ./:/app  # 挂载项目目录，包含Dangerfile及代码
    command: danger pr https://github.com/your-org/your-repo/pull/123

关键配置参数

挂载说明

• 项目目录挂载：将本地项目根目录挂载至容器内/app路径，确保Danger能访问项目代码及Dangerfile
• 配置文件挂载：如需使用自定义工具配置（如ESLint、RuboCop配置），可额外挂载配置目录至/config路径，并在Dangerfile中引用

注意事项

• API令牌安全：避免将令牌直接写入命令或配置文件，建议通过环境变量注入
• Dangerfile语法：需符合Danger工具语***范（支持JavaScript/TypeScript或Ruby）
• 权限配置：确保API令牌具有足够权限（如GitHub令牌需包含代码仓库的读写权限）
• 规则测试：新规则上线前建议在测试环境验证逻辑，避免影响正式CI/CD流程