fatedier / freebot Goto Github PK

View Code? Open in Web Editor NEW

44.0 6.0 15.0 590 KB

A simple github workflow bot.

License: Apache License 2.0

Makefile 0.11% Go 99.89%

github github-bot bot workflow ci

freebot's Introduction

freebot

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

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

开发通过 /status wip 给 PR 加上 status/wip 的标签。
开发完成，开发执行 /status wait-review 将状态修改为待 review 且 /cc @user1 将 user1 指定为 reviewer。
user1 如果 review 未通过，可以将状态修改为 request-changes。
user1 如果 review 通过，/status approved 将状态修改为 approved。
开发执行 /status testing 并通过 /cc @user2 抄送 QA。
QA 收到通知，开始测试，如果测试不通过，回到 request-changes，测试通过，则 /status merge-ready。
开发通过 /merge 将代码合并，进行后续的上线操作。

配置

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

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

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

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

格式如下:

{
    "fatedier/freebot": {
        "alias": {},
        "roles": {},
        "plugins": {
            "assign": {
                "enable"
            }
        }
    }
}

功能

插件

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

插件详细说明

别名

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

{
    "alias": {
        "cmds": {
            "s": "status"
        },
        "labels": {
            "wr": "wait-review"
        },
        "users": {
            "aaa": "bbb"
        }
    }
}

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

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

角色

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

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

示例:

{
    "roles": {
        "owner": ["user1", "user2"],
        "qa": ["qa1"]
    },
    "label_roles": {
        "module/cmd": {
            "owner": ["user3"]
        }
    }
}

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

freebot's People

Contributors

Stargazers

Watchers

Forkers

blizard863 awesome-archive googx hbhuangbin jiangpeipei327 marciopocebon lhongjum jambestwick kybru91 rising622 icodein 2214998 tjloved

freebot's Issues

新增 plugin trigger

对于指定的 event 可以执行一个外部脚本。

配置文件优化

主配置中可以指定一个目录用于存放每一个 repo 的配置文件。
文件格式同 repo_conf 下面层级的格式 map[string]map[string]RepoConf
通过 reload 命令重新加载配置。

优化日志，能够跟踪一条 webhook request

reqid ，graceful shutdown 支持

根据 PR 修改了哪些文件，打上对应的 label

示例的流程：

根据修改了哪些文件，打上对应的 module/xxx 的 label。
role 可以根据 label 做特殊配置，例如只在有 module/docker 的 label 的 PR 中才是 owner。
收到 pull request review 的 webhook 后，如果是 approved，且 approve 的用户是某个 module 的 owner，则会打上 approved/xxx 的 label。
如果 PR 的 author 有新的 commit 提交，则移除所有的 approved/xxx 标签。
通过 /merge 合并时，precondition 中可以要求每一个 module/xxx 标签，都需要有一个对应的 approved/xxx 标签。