Danger项目入门指南：从零开始搭建代码审查自动化工具

Danger项目入门指南：从零开始搭建代码审查自动化工具

danger 🚫 Stop saying "you forgot to …" in code review (in Ruby) 项目地址: https://gitcode.com/gh_mirrors/da/danger

前言

在现代软件开发流程中，代码审查是保证代码质量的重要环节。Danger作为一款强大的代码审查自动化工具，可以帮助团队在持续集成环境中自动执行代码规范检查、风险提示等任务。本文将详细介绍如何从零开始搭建Danger环境。

环境准备

1. 安装Danger

我们强烈推荐使用Bundler来管理Ruby依赖，这能确保Danger及其插件的版本控制更加规范。

安装步骤：

1. 如果已有Gemfile，添加gem 'danger'（GitHub）或gem 'danger-gitlab'（GitLab）
2. 若无Gemfile，执行bundle init创建后编辑
3. 运行bundle install安装依赖

Bundler简介： Bundler是Ruby的依赖管理工具，通过Gemfile定义项目所需的Ruby组件。它能精确控制依赖版本，避免环境冲突。

2. 快速初始化（推荐）

执行以下命令可快速完成后续所有设置：

bundle exec danger init

该命令会引导你完成后续步骤，提供针对特定环境的建议。

核心配置

1. 创建Dangerfile

Dangerfile是Danger的核心配置文件，使用Ruby语法编写：

# 简单示例
message("Hello, this worked")

注意事项：

• 文件名为Dangerfile（无扩展名）
• 某些编辑器可能无法自动识别Ruby语法，需手动设置

2. 创建专用机器人账号

虽然可选，但强烈建议为Danger创建专用账号，原因包括：

• 隔离权限，提高安全性
• 便于识别自动化操作
• 避免使用个人账号的API限制

平台特定配置

GitHub环境配置

1. 账号设置：

   • 公开项目：无需将机器人加入组织/仓库
   • 私有项目：需添加机器人并授予"Write"权限

2. API令牌：

   • 公开项目：使用public_repo范围
   • 私有项目：使用完整repo范围
   • 企业版需额外设置：

     DANGER_GITHUB_HOST=your.company.com
     DANGER_GITHUB_API_BASE_URL=https://your.company.com/api/v3
     

GitLab环境配置

1. 账号设置：

   • 公开项目：无需添加机器人
   • 私有项目：添加为"Reporter"权限

2. 自托管配置：

   DANGER_GITLAB_HOST=your.gitlab.com
   DANGER_GITLAB_API_BASE_URL=https://your.gitlab.com/api/v4
   

Bitbucket配置

• Cloud版本需要设置：

  DANGER_BITBUCKETCLOUD_USERNAME
  DANGER_BITBUCKETCLOUD_PASSWORD
  DANGER_BITBUCKETCLOUD_UUID
  

• Server版本需要：

  DANGER_BITBUCKETSERVER_USERNAME
  DANGER_BITBUCKETSERVER_PASSWORD
  DANGER_BITBUCKETSERVER_HOST
  

持续集成设置

Danger设计为在CI环境中运行，常见支持的环境包括：

• Travis CI
• CircleCI
• Jenkins
• GitLab CI
• Bitrise等

配置要点：

1. 确保CI环境已配置
2. 添加必要的环境变量
3. 在构建步骤中加入bundle exec danger

高级安装选项

非Bundler安装

若项目无其他Ruby依赖，可直接安装：

gem install danger --version '~> 5.0'

macOS无sudo安装

在~/.profile中添加：

export GEM_HOME=$HOME/.gem
export PATH=$GEM_HOME/bin:$PATH

最佳实践建议

1. 权限最小化：始终遵循最小权限原则配置API令牌
2. 环境隔离：为不同环境使用独立机器人账号
3. 版本控制：使用Bundler锁定Danger版本
4. 渐进式规则：从简单规则开始，逐步完善检查项

通过以上步骤，您已成功搭建Danger环境，可以开始定义适合团队的代码审查规则了。Danger的强大之处在于其灵活性，您可以根据项目需求定制各种自动化检查规则。

danger 🚫 Stop saying "you forgot to …" in code review (in Ruby) 项目地址: https://gitcode.com/gh_mirrors/da/danger