Issue Bot 使用方法
約 569 字大約 2 分鐘
Issue Bot 使用的 Action 為 issue-checker,配置檔案為 issue-checker.yml。
注意
拉取請求(PR)被加上 ambiguous 標籤是因為沒有按照 Commitizen 規範提交。
功能
自動觸發
- 針對議題 (Issue) 與拉取請求 (Pull Request),Issue Bot 會根據關鍵字自動進行分類,並加上
module系列、client系列、ambiguous、translation required等標籤。
具體關鍵字可以參閱 配置檔案。 - 針對身分設為公開 (Public) 的 MAA 成員,為其發起的議題與拉取請求加上
MAA Team標籤。
議題 (Issue) 及其評論
- 為上傳檔案失敗的議題增加
incomplete標籤並留言評論,提醒使用者檔案上傳失敗。
拉取請求 (Pull Request)
Issue Bot 會對拉取請求標題的格式進行簡單審查。除非標題以下列任一單字開頭,否則它會增加 ambiguous 標籤:
build,chore,ci,doc,docs,feat,fix,perf,refactor,rft,style,test,i18n,typo,debugRevert,revert,Release,release
手動觸發
請多利用關鍵字詳細描述問題以自動觸發分類標籤,盡量少使用下列指令。
但當您知道自己的行為會導致 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標籤:1https://github.com/MaaAssistantArknights/MaaAssistantArknights/commit/{COMMIT_HASH} fixedfixed by https://github.com/MaaAssistantArknights/MaaAssistantArknights/commit/{COMMIT_HASH}{VERSION} fixedfixed by {VERSION}
Duplicate of #{ISSUE_NUMBER}:可以為目前議題增加duplicate標籤。- 當您知道自己的議題評論會導致 Issue Bot 誤解時,請盡量新增一些 skip 操作。
注意
1 這裡的 COMMIT_HASH 取 8~40 位元字元即可,不必是完整的 40 位元。
推送 (Push)
Issue Bot 不會處理推送事件。在 Commit Message 中包含 fix #{ISSUE_NUMBER}、close #{ISSUE_NUMBER} 等關閉關鍵字,待提交合併進預設分支後,GitHub 會自動關閉對應議題,但不會為其增加 fixed 標籤。
