Issue Man

Issue Man 是一个通过配置文件定义并管理 GitHub Issue 生命周期的机器人。

配置化的工作流程

Issue Man 的工作流程完全由配置文件决定，您可以根据自己的需要，编写自己特有的流程。Issue Man 在工作时服务的仓库，仓库的管理员，每条指令的名称，对权限的要求，数量限制，涉及的 label，assignees 改动，issue 的关闭，提示文本等。所有的内容都是通过配置文件来定义的。

虽然 Issue Man 很多选项都可以自行配置，但这不代表一定需要配置，很多配置项都是可以缺省不填的，对此，Issue Man 不会做其它额外的动作，只会安装你定义的指令来处理。

这儿有一个简单的流程定义示例：

full_repository_name: "gorda/gorda.io"
maintains:
  - "gorda"
flows:
  # /accept 指令
  - name: "/accept"
    permission:
      - "maintainers"
      - "member"
    current_label:
      - "status/spending"
    target_label:
      - "status/waiting-for-pr"
    success_feedback: "Thank you @somebody, this issue had been assigned to you."

  # /pushed 指令
  - "name": "/pushed"
    permission:
      - "maintainers"
      - "self"
    current_label:
      - "status/waiting-for-pr"
    target_label:
      - "status/reviewing"

  # /merged 指令
  - "name": "/merged"
    permission:
      - "maintainers"
      - "self"
    current_label:
      - "status/reviewing"
    target_label:
      - "status/merged"
    close: true

其包含了三条 指令：/accept，/pushed，/merged。这是一种常见的基于 issue 的工作流程。据我所知，ServiceMesher 和 k8smeetup 都是采用的这种工作流程。

除此之外，你还可以根据自己的需要自定义任何指令及其操作。在了解 Issue Man 的基本用法后，你可以查看指令文档了解完整的 Issue Man 目前支持的配置项。

Issue Man 执行过程

解析 webhook 数据，通过 go-playground/webhooks 实现。
拼装数据，根据 GitHub API 要求，以及自身需要拼装数据。
发送请求，通过 go-github 实现。

启动时，获取 issue 列表，存储 issue 与路径的对应关系

自动同步图片

fork 仓库

基于最新的 istio/istio.io 更新

自动复制所有图片，

调用提交 PR

扫描文件 Title 包含 Deprecated 则加上标签，不再追踪？

追踪方式

对无人维护的 issue，不做 comment（但是会更新文件列表）

对有人维护的 issue，持续追踪：

~~1. 获取并遍历 commit，从 HEAD 向前遍历，直至找到上次的 commit sha https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository~~

~~1. 获取 commit 对应的 PR（一个 PR 的多个 commit 去重） https://developer.github.com/v3/repos/commits/#list-pull-requests-associated-with-commit~~

获取并遍历 PR，直至找到上一次检测的 PR number
获取 PR 涉及的文件，根据路径和状态，对 issue 列表中管理的 issue 做出处理。对于重命名文件，可以根据 previous_filename 获取之前的文件名 https://developer.github.com/v3/pulls/#list-pull-requests-files
找到文件对应的 issue，调用 issue 相关的 api（新增、删除、重命名、更新、comment） https://developer.github.com/v3/issues/

issue 模板 title: docs/tasks/traffic-management/traffic-shifting body: path: content/en/docs/tasks/traffic-management/traffic-shifting/index.md

comment 模板 maintainer：@assignees status: added/modified/renamed/removed pr: diff：https://github.com/istio/istio.io/pull/<pr_number>/files#diff-<md5(filename)>

diff: https://github.com/istio/istio.io/commit/<commit_sha>#diff-<md5(filename)> ???

3ks / issue-man

Issue Man

配置化的工作流程

Issue Man 执行过程

自动同步图片

追踪方式

About

Languages