auto-assign 项目使用教程

auto-assign 项目使用教程

1. 项目的目录结构及介绍

auto-assign/
├── .github/
│   ├── workflows/
│   │   └── auto-assign.yml
├── data/
│   └── private-key.pem
├── .gitignore
├── LICENSE
├── README.md
├── app.yml
└── index.js

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• data/: 存储项目的私有密钥文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目的许可证文件。
• README.md: 项目的主要说明文档。
• app.yml: 项目的配置文件。
• index.js: 项目的入口文件。

2. 项目的启动文件介绍

index.js 是项目的入口文件，负责启动和配置 Probot 应用。以下是 index.js 的主要内容：

const { Probot } = require('probot');
const app = require('.');

Probot.run(app);

该文件导入了 Probot 库和项目的应用配置，并通过 Probot.run 方法启动应用。

3. 项目的配置文件介绍

app.yml 是项目的配置文件，用于定义项目的各种设置，包括添加审阅者和指派者等。以下是 app.yml 的主要内容：

addAssignees: true
reviewers:
  - reviewerA
  - reviewerB
  - reviewerC
numberOfReviewers: 0
numberOfAssignees: 2

• addAssignees: 是否添加指派者。
• reviewers: 定义要添加的审阅者列表。
• numberOfReviewers: 要添加的审阅者数量，0 表示添加所有审阅者。
• numberOfAssignees: 要添加的指派者数量。

通过这些配置，可以灵活地管理项目的审阅和指派流程。