Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.89 KB

IssueBot使用方法.md

File metadata and controls

60 lines (41 loc) · 2.89 KB

Issue bot 使用方法

Issue bot 使用的 action 为 issue-checker,配置文件为 issue-checker.yml

Note: PR 被打上 ambiguous 标签可能是因为没有按照 commitizen 规范提交。推荐在 PR 标题加上 docs/feat/fix/merge/release 等。

功能

自动触发

  • 给上传文件失败的议题评论,告诉用户文件上传失败。
  • 给 议题 和 拉取请求 增加标签,包括 module 系列,Client 系列,ambiguoustranslation required 等。
    Issue bot 会根据关键词自动增加分类标签,也可以通过手动添加的方式增加或删除标签。
    具体关键词可以参考配置文件
  • 给可见性设置为 public 的 MAA 成员增加 MAA Team 标签。

手动触发

多使用关键词详细描述问题来自动触发分类标签,少使用下列指令。但当你知道自己的行为会导致 Issue bot 误解时除外

尽量不要直接增加或删除分类标签,因为手动增加或删除的分类标签可能在修改后会被恢复原样。

议题(Issue)及其评论

修改/新增 一个议题时:

  • Add {LABEL_NAME} 可以增加一个标签。
  • Remove {LABEL_NAME} 可以删除一个标签。
  • Remove labels 可以删除所有标签。

修改/新增 一个议题评论时:

  • Add ambiguous 可以保证不删除 ambiguous 标签,但没有 ambiguous 标签时不会添加。
  • Remove {LABEL_NAME} 可以保证不增加标签。1
  • Remove labels 可以保证不增加任何标签。1
  • 以下几种方法可以为议题增加 fixed 标签:2
    • https://github.com/MaaAssistantArknights/MaaAssistantArknights/commit/{COMMIT_HASH} fixed
    • fixed by https://github.com/MaaAssistantArknights/MaaAssistantArknights/commit/{COMMIT_HASH}
    • {VERSION} fixed
    • fixed by {VERSION}
  • Duplicate of #{ISSUE_NUMBER} 可以为当前议题增加 duplicate 标签。
  • 当你知道自己的议题评论会导致 Issue bot 误解时,尽量添加一些 remove 操作。

Note1: Remove ambiguousRemove labels 会删除 ambiguous 标签。
Note2: 这里的 COMMIT_HASH 需要完整的 40 位。

拉取请求(Pull Request)及其评论

议题(Issue)及其评论基本相同。另外:

  • Release {VERSION} 会增加 release 标签。
  • 不会自动添加 fixed, duplicate 标签。

推送(Push)

  • 在 commit message 中包含以下几种任意一个,可以为对应议题加上 fixed 标签:
    • fix #{ISSUE_NUMBER}
    • close #{ISSUE_NUMBER}
    • fix https://github.com/MaaAssistantArknights/MaaAssistantArknights/issues/{ISSUE_NUMBER}
    • close https://github.com/MaaAssistantArknights/MaaAssistantArknights/issues/{ISSUE_NUMBER}