https://github.com/fatedier/freebot

A simple github workflow bot.
https://github.com/fatedier/freebot

bot ci github github-bot workflow

Last synced: 2 months ago
JSON representation

A simple github workflow bot.

• Host: GitHub
• URL: https://github.com/fatedier/freebot
• Owner: fatedier
• License: apache-2.0
• Created: 2019-01-29T13:23:28.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-04T11:43:43.000Z (almost 6 years ago)
• Last Synced: 2024-10-20T08:32:34.743Z (2 months ago)
• Topics: bot, ci, github, github-bot, workflow
• Language: Go
• Size: 576 KB
• Stars: 47
• Watchers: 6
• Forks: 15
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# freebot

freebot 是一个帮助团队基于 github 的 issue 和 pull request 进行工作流管理的 bot。

支持通过 comment 命令的方式执行一些经过前置检查的操作以及一些自动化的流程。

## 目录

* [简单示例](#简单示例)

* [配置](#配置)

* [功能](#功能)

    * [插件](#插件)

    * [别名](#别名)

    * [角色](#角色)

### 简单示例

通过示例的 [freebot.conf](./example/freebot.conf) 快速尝试。

根据自己的需要修改 owner, repo 和 plugin 的相关配置。

执行 `./freebot -c ./freebot.conf`

在 github 上配置 repo 的 webhook 地址为 freebot 的监听地址。

示例配置的简单工作流说明:

1. 开发通过 `/status wip` 给 PR 加上 `status/wip` 的标签。

2. 开发完成，开发执行 `/status wait-review` 将状态修改为待 review 且 `/cc @user1` 将 user1 指定为 reviewer。

3. user1 如果 review 未通过，可以将状态修改为 `request-changes`。

4. user1 如果 review 通过，`/status approved` 将状态修改为 `approved`。

5. 开发执行 `/status testing` 并通过 `/cc @user2` 抄送 QA。

6. QA 收到通知，开始测试，如果测试不通过，回到 `request-changes`，测试通过，则 `/status merge-ready`。

7. 开发通过 `/merge` 将代码合并，进行后续的上线操作。

### 配置

由于 freebot 同时支持配置多个 repo，且每一个 repo 的 plugin 都可以有自定义的配置，为了避免单个配置文件过长，难以维护，支持将每一个 repo 的配置分散在一个指定目录中。

freebot 会用定期轮询的方式读取指定目录的配置，如果检测到配置有变化，会动态更新。

在配置文件中配置 `repo_conf_dir` 来启用此功能，通过 `repo_conf_dir_update_interval_s` 指定轮询检测的间隔时间。

`repo_conf_dir` 目录下的所有文件都会被解析为对应的 repo 的配置。

格式如下:

```json

{

    "fatedier/freebot": {

        "alias": {},

        "roles": {},

        "plugins": {

            "assign": {

                "enable"

            }

        }

    }

}

```

### 功能

#### 插件

每一个插件提供了一些基础的能力，通过为每一个 repo 进行插件配置从而实现定制化的团队工作流。

[插件详细说明](./plugin/README.md)

#### 别名

在 github 的 comment 中敲命令，没有自动补全是一件很繁琐的事，通过设置别名来简化这一操作。

```

{

    "alias": {

        "cmds": {

            "s": "status"

        },

        "labels": {

            "wr": "wait-review"

        },

        "users": {

            "aaa": "bbb"

        }

    }

}

```

可以给命令，标签和用户分别设置别名。

原先需要添加评论 `/status wait-review`，使用别名后只需要输入 `/s wr` 即可。

#### 角色

可以为指定的用户分配指定角色，在之后的插件中的前置条件可以对 author 的角色有要求。例如限制只有 owner 角色的用户才能执行某些命令。

还可以设置当存在某个 label 时某个用户为指定的角色。

示例:

```json

{

    "roles": {

        "owner": ["user1", "user2"],

        "qa": ["qa1"]

    },

    "label_roles": {

        "module/cmd": {

            "owner": ["user3"]

        }

    }

}

```

上面的示例表示当 issue 或 PR 存在 `module/cmd` 的 label 时，user3 的角色是 owner。