docs(審查步驟編號): 依新順序重編步驟編號與說明
node-actions/template: CI / BUILD (pull_request) Successful in 5s
CI / TEST (Claude) (pull_request) Successful in 27s
CI / TEST (Codex) (pull_request) Successful in 31s
CI / TEST (Antigravity) (pull_request) Failing after 36s

This commit is contained in:
Jeffery
2026-07-20 09:46:12 +08:00
parent d751cee69d
commit 8662e8ca80
6 changed files with 86 additions and 85 deletions
+4 -4
View File
@@ -80,7 +80,7 @@ async function listAll(ctx, apiPath) {
* @returns {Promise<object>} Gitea 使用者物件(含 `id`、`login` 等欄位,
* 依 Gitea API 回應而定)。
* @throws {Error} 請求失敗(非 2xx,例如 token 無效時 401)由底層 `api` 丟出。
* @remarks 使用情境:action 步驟 8 先查出 bot 自己的帳號,
* @remarks 使用情境:action 步驟 2 先查出 bot 自己的帳號,
* 之後比對 PR 留言的作者,辨識哪些留言是本 action 先前發出的
* (例如要將舊留言標註為已過時)。
*/
@@ -178,7 +178,7 @@ function createIssue(ctx, { title, body, labels }) {
* @returns {Promise<Array<object>>} 留言物件陣列(含 `id`、`body`、`user` 等欄位);
* 無留言時為空陣列。
* @throws {Error} 任一頁請求失敗(非 2xx)由底層 `api` 丟出,錯誤附 `status`、`data`。
* @remarks 使用情境:步驟 8 重跑 review 前,先撈出 PR 全部留言並搭配 `whoAmI`
* @remarks 使用情境:步驟 2 重跑 review 前,先撈出 PR 全部留言並搭配 `whoAmI`
* 比對作者,找出本 action(bot)先前發過的留言,以便編輯標註為已過時。
*/
function listIssueComments(ctx) {
@@ -237,7 +237,7 @@ function createReview(ctx, body, comments) {
* @returns {Promise<Array<object>>} review 物件陣列(含 `id`、`user`、`body` 等欄位);
* 無 review 時為空陣列。
* @throws {Error} 任一頁請求失敗(非 2xx)由底層 `api` 丟出,錯誤附 `status`、`data`。
* @remarks 使用情境:步驟 8 重跑 review 前,先找出 PR 上既有 review,
* @remarks 使用情境:步驟 2 重跑 review 前,先找出 PR 上既有 review,
* 再以 `listReviewComments` 取出其行內留言做後續解決標記。
*/
function listReviews(ctx) {
@@ -280,7 +280,7 @@ function listReviewComments(ctx, reviewId) {
* @param {number|string} commentId - 要標記為已解決的行內留言 id。
* @returns {Promise<boolean>} 標記成功回傳 `true`;任何失敗
* (版本不支援、權限不足、留言不存在等)一律回傳 `false`,不丟出例外。
* @remarks 使用情境:步驟 8 嘗試把舊回合的行內留言標記為已解決;若回傳 `false`
* @remarks 使用情境:步驟 2 嘗試把舊回合的行內留言標記為已解決;若回傳 `false`
* (例如目標 Gitea 版本無此 API),呼叫端應停止嘗試並記 WRN
* (由 `resolveOldComments` 實作此降級)。
*/