Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 2.69 KB

2.3-IssueBot使用方法.md

File metadata and controls

61 lines (41 loc) · 2.69 KB

Issue Bot 使用方法

Issue Bot 使用的 action 為 issue-checker，設定檔為 issue-checker.yml。

注意：拉取請求被增加 ambiguous 標籤是因為沒有按照 commitizen 規範提交。

功能

自動觸發

  • 給 議題 和 拉取請求 增加標籤，包括 module 系列，Client 系列，ambiguous，translation required 等。 Issue Bot 會根據保留字自動增加分類標籤。 具體保留字可以參考設定檔。
  • 給作者是可見性設置為 public 的 MAA 成員的 議題 和 拉取請求 增加 MAA Team 標籤。

議題（Issue）及其評論

  • 給上傳檔案失敗的議題增加 incomplete 標籤并評論，告訴使用者檔案上傳失敗。

拉取請求（Pull Request）

Issue Bot 會對拉取請求標題的格式進行簡單審查。它會增加 ambiguous 標籤，除非拉取請求標題以下列任一單字開頭：

  • build chore ci doc docs feat fix perf refactor rfc style test
  • Merge merge Revert revert

手動觸發

多使用保留字詳細描述問題來自動觸發分類標籤，少使用下列指令。
但當你知道自己的行為會導致 Issue Bot 誤解時除外。

議題（Issue）及拉取請求（Pull Request）

  • Remove {LABEL_NAME} 可以删除一個標籤。
  • Remove labels 可以删除所有標籤。
  • Skip {LABEL_NAME} 可以跳过一個標籤。
  • Skip labels 可以跳过所有標籤。

議題評論（Issue Comments）及拉取請求評論（Pull Request Comments）

  • Skip {LABEL_NAME} 可以保證不增加標籤。
  • Skip labels 可以保證不增加任何標籤。
  • 以下幾種方法可以為議題增加 fixed 標籤：1
    • 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 誤解時，盡量添加一些 skip 操作。

Note1: 這裡的 COMMIT_HASH 需要完整的 40 位。

推送（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}