Danger开源项目使用教程

1. 项目目录结构及介绍

Danger 是一个在持续集成中自动执行代码审查任务的工具，其目录结构如下：

awesome-danger/
├── .gitignore
├──/LICENSE
├── README.md
├── danger/awesome-danger
│   ├── .danger.json
│   ├── .gitattributes
│   ├── .github
│   │   ├── workflows
│   │   └── ...
│   ├── ...

• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目使用的许可证文件。
• README.md: 项目说明文件。
• danger/awesome-danger:Danger 项目的核心目录。
  • .danger.json: Danger 的配置文件。
  • .gitattributes: Git 属性文件，用于定义特定文件的Git行为。
  • .github: 包含GitHub工作流程和其他GitHub相关配置的目录。
  • workflows: 包含GitHub Actions工作流程文件的目录。

2. 项目的启动文件介绍

在 awesome-danger 目录中，没有特定的“启动文件”，因为Danger通常作为CI/CD流程的一部分运行。不过，.github/workflows 目录下的工作流程文件（例如 ci.yml）是触发Danger任务的关键。

以下是一个简化版的GitHub Actions工作流程示例：

name: Danger

on: [pull_request]

jobs:
  danger:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Setup Ruby
      uses: actions/setup-ruby@v1
      with:
        ruby-version: 2.6
    - name: Install dependencies
      run: |
        gem install danger
    - name: Run Danger
      run: danger

这个工作流程会在每次拉取请求时运行，并使用Ruby环境来安装和执行Danger。

3. 项目的配置文件介绍

.danger.json 是 Danger 的主要配置文件，它允许你自定义Danger的行为。以下是一个配置文件的示例：

{
  "vetter": {
    "require色泽": true,
    "require_jira": true
  },
  "messages": {
    "require色泽": "PR需要一个色泽标签。",
    "require_jira": "PR需要关联一个JIRA问题。"
  },
  "warnings": {
    "commit_lint": "Commit消息需要遵循我们的格式。"
  }
}

在这个配置文件中，你可以指定哪些“vetter”（检查器）需要被运行，以及当这些检查器发现问题时应该显示的消息。

• vetter: 定义要运行的检查器。
• messages: 定义每个检查器发现问题时显示的消息。
• warnings: 定义警告消息，这些消息不会阻止PR的合并，但会提醒审查者。

以上就是Danger开源项目的使用教程，通过上述步骤，你可以开始使用Danger来自动化你的代码审查过程。