diff --git a/skills/code-review-resolve/SKILL.md b/skills/code-review-resolve/SKILL.md index f7bf542..d7d4173 100644 --- a/skills/code-review-resolve/SKILL.md +++ b/skills/code-review-resolve/SKILL.md @@ -1,17 +1,19 @@ --- name: code-review-resolve -description: 讀取工作目錄 `.gitea/ai-review/findings.json`（Gitea AI review 產出的問題清單），依嚴重等級（🔴 嚴重→🟠 高→🟡 中→🔵 低）由高到低逐條解決程式碼問題；全部解完後把 `.gitea/ai-review/findings.json` 清空為空陣列 `[]`。接著做 git 處理：分析工作區內所有檔案變更，依異動內容歸類為 feat/fix/docs/style/refactor/perf/test/chore/revert，分門別類各自 commit，commit 訊息為「type(中文範圍): 一句總結」格式（例 `feat(新增功能): 新增使用者登入流程`、`perf(優化效能): 改用批次查詢降低 DB 往返`）。當使用者說解決 findings、處理 AI review 問題、修掉 .gitea/ai-review 的問題、依嚴重度逐條修復後分類提交、或要把工作區變更依 conventional commit 分類 commit 時觸發。不適用於：產生 findings（那是 Gitea AI review CI 或 /jsc:code-review 的工作）、單純審查不修改、或不分類的單一 commit。 -argument-hint: "[--findings ] [--no-commit] [--yes]" +description: 讀取工作目錄 `.gitea/ai-review/findings.json`（Gitea AI review 產出的問題清單），依嚴重等級（🔴 嚴重→🟠 高→🟡 中→🔵 低）由高到低逐條解決程式碼問題；全部解完後把 `.gitea/ai-review/findings.json` 清空為空陣列 `[]`。接著做 git 處理：分析工作區內所有檔案變更，依異動內容歸類為 feat/fix/docs/style/refactor/perf/test/chore/revert，分門別類各自 commit，commit 訊息為「type(中文範圍): 一句總結」格式（例 `feat(新增功能): 新增使用者登入流程`、`perf(優化效能): 改用批次查詢降低 DB 往返`）。提交後 push 當前分支（先用認證管理器、失敗改用 token、再失敗詢問使用者），push 成功後用 token 透過 Gitea API 對目標分支發 PR（目標分支不明必須詢問、不可猜測），PR 描述可選完整版（重新分析 git diff 總結）／簡單版（逐條列 commit 訊息）／使用者輸入；完成後因內文可能含 gitea token，提醒並清除 AI 助理對話內文。當使用者說解決 findings、處理 AI review 問題、修掉 .gitea/ai-review 的問題、依嚴重度逐條修復後分類提交、或要把工作區變更依 conventional commit 分類 commit 並 push 開 PR 時觸發。不適用於：產生 findings（那是 Gitea AI review CI 或 /jsc:code-review 的工作）、單純審查不修改、或不分類的單一 commit。 +argument-hint: "[--findings ] [--target <目標分支>] [--pr-desc ] [--no-commit] [--no-pr] [--yes]" --- -# code-review-resolve — 解決 AI review findings 並分類提交 +# code-review-resolve — 解決 AI review findings、分類提交、push 並開 PR -兩階段 skill：先**逐條修掉** `.gitea/ai-review/findings.json` 裡的問題並清空該檔，再把工作區所有變更**依 conventional commit 類型分門別類 commit**。 +四階段 skill：先**逐條修掉** `.gitea/ai-review/findings.json` 裡的問題並清空該檔，再把工作區所有變更**依 conventional commit 類型分門別類 commit**，接著 **push 當前分支**，最後**透過 Gitea API 發 PR**。 | 階段 | 動作 | | --- | --- | | A. 解決問題 | 讀 `findings.json` → 依等級 🔴→🟠→🟡→🔵 逐條修復程式碼 → 清空 `findings.json` 為 `[]` | | B. 分類提交 | 分析工作區所有變更 → 依 feat/fix/docs/style/refactor/perf/test/chore/revert 分組 → 各組一個 commit | +| C. Push 當前分支 | 認證管理器 → 失敗改 token → 再失敗詢問使用者 | +| D. 發出 PR | 確定目標分支（不明必問）→ 選 PR 描述（完整／簡單／自訂）→ token 呼叫 Gitea API 建 PR → 通知並清除內文 | --- @@ -20,17 +22,21 @@ argument-hint: "[--findings ] [--no-commit] [--yes]" - **語言**：所有面向使用者的輸出（修復清單、提交計畫、總結、反問）與 **commit 訊息** 一律使用**繁體中文（台灣用語）**； 僅程式碼識別字、檔名、git 指令、conventional commit 的 `type`（`feat`/`fix`…）等技術標識保留原文，**不可**使用簡體字。 - **編碼無亂碼**：讀寫檔案一律 **UTF-8（不含 BOM）**；清空後的 `findings.json` 與所有 commit 訊息確保中文、全形標點與等級 emoji（🔴🟠🟡🔵）正常顯示，不得出現問號方框或錯碼。 -- **修改程式碼與 commit 屬於更動專案的行為**：除非帶 `--yes` 或使用者已明確授權，**否則每階段動手前先輸出計畫（預覽）並取得同意**；使用者拒絕則只輸出計畫、不動檔不提交。 +- **修改程式碼、commit、push、開 PR 屬於更動專案／對外行為**：除非帶 `--yes` 或使用者已明確授權，**否則每階段動手前先輸出計畫（預覽）並取得同意**；使用者拒絕則只輸出計畫、不動檔不提交不推送。 +- **Token 機密保護（極重要）**：gitea token 一律**從環境變數讀取**（如 `$GITEA_TOKEN`），**絕不**寫死在 skill、commit、PR 內文或任何輸出；**不可** echo 含 token 的指令或 URL、不可寫進 log。所有顯示給使用者的指令／錯誤訊息都要**遮蔽 token**（如以 `***` 取代）。階段 D 完成後依規範清除對話內文（見 D5）。 --- ## 參數 -格式：`[--findings <路徑>] [--no-commit] [--yes]` +格式：`[--findings <路徑>] [--target <目標分支>] [--pr-desc ] [--no-commit] [--no-pr] [--yes]` - `--findings <路徑>`：findings 檔路徑。**省略時預設 `.gitea/ai-review/findings.json`**（相對於工作目錄根）。 -- `--no-commit`：只做階段 A（修復 + 清空 findings），**不**執行階段 B 的 commit。 -- `--yes`：略過各階段的同意確認，直接執行（修復、清空、commit 一氣呵成）。未帶時每階段先預覽再確認。 +- `--target <目標分支>`：PR 的目標分支。**省略時於階段 D 必須詢問使用者，不可猜測**。 +- `--pr-desc `：PR 描述形式。`full`＝完整版（重新分析 diff 總結）、`simple`＝簡單版（逐條列 commit 訊息）、或直接給自訂文字；省略則於階段 D 詢問。 +- `--no-commit`：只做階段 A（修復 + 清空 findings），**不**執行階段 B/C/D（不提交、不推送、不開 PR）。 +- `--no-pr`：執行到階段 C（push）為止，**不**開 PR（階段 D 略過）。 +- `--yes`：略過各階段的同意確認，直接執行（修復、清空、commit、push、開 PR 一氣呵成）。未帶時每階段先預覽再確認。 --- @@ -142,26 +148,107 @@ git commit -m "type(中文範圍): 一句總結" - **逐組 add／commit**，確保每個 commit 只含該類異動；不要一次 `git add -A` 再混在一起。 - 改名／刪除檔一併納入對應組的 `git add`（`git add -A -- <路徑>` 或明確列出）。 -- **不**自動 `git push`、不開 PR（除非使用者另外要求）。 +- commit 完成後進入階段 C（push）；`--no-commit` 或無新 commit 時不進入後續階段。 + +--- + +## 階段 C：Push 當前分支（`--no-commit`／無新 commit 時略過） + +commit 完成後推送**當前分支**，依序嘗試三種方式，前者失敗才退到下一個： + +1. **認證管理器（優先）**：直接用 git 既有的 credential helper（如 Windows 的 `manager-core`）： + + ```bash + git push -u origin "$(git rev-parse --abbrev-ref HEAD)" + ``` + +2. **失敗 → 改用 token push**：從環境變數讀 token，組帶 token 的遠端 URL 推送。**整個過程不可把含 token 的指令／URL 印出來**（用變數帶入、輸出時遮蔽）： + + ```bash + # GITEA_TOKEN 來自環境變數；解析 origin 的 host/owner/repo + git push "https://oauth2:${GITEA_TOKEN}@//.git" \ + "$(git rev-parse --abbrev-ref HEAD)" + ``` + + （token 用完即棄，不寫進 git remote 設定、不落地。） + +3. **再失敗 → 詢問使用者要如何 push**：列出失敗原因（遮蔽 token），請使用者指示推送方式，**不可自行猜測**其他憑證或來源。 + +push 成功後記下遠端分支名，進入階段 D。 + +--- + +## 階段 D：透過 Gitea API 發出 PR（`--no-pr`／`--no-commit` 時略過） + +### D1. 確定目標分支（不可猜想） + +- 帶 `--target <分支>` → 直接採用。 +- **否則必須詢問使用者目標分支**（可用 `git branch -r` 列出輔助選擇），**嚴禁臆測或預設**（不可自行假設 develop／main／master）。 + +### D2. 解析 repo 座標 + +從 `git remote get-url origin` 解析出 **host／owner／repo**（例：`https://gitea.jsc.idv.tw/plugins/code-review.git` → host=`gitea.jsc.idv.tw`、owner=`plugins`、repo=`code-review`）。 + +### D3. 決定 PR 描述形式（完整版／簡單版／使用者輸入） + +依 `--pr-desc`（或詢問）三選一： + +- **完整版（`full`）**：**重新分析並總結** `git diff ...<當前分支>`（比對 source 自分岔點以來的變更），整理成結構化繁體中文說明 —— 變更摘要、影響範圍、重點檔案／模組、風險或注意事項。不是貼原始 diff，而是「人讀得懂的總結」。 +- **簡單版（`simple`）**：直接把本分支領先 target 的 commit 訊息**逐條列出**： + + ```bash + git log --oneline "..$(git rev-parse --abbrev-ref HEAD)" + ``` + + 以條列呈現每行 commit 訊息。 +- **使用者輸入**：採用使用者提供的描述文字。 + +PR **標題**預設取一句總結（可用首個 feat/fix commit 或分支用途）；使用者另有指定則從之。 + +### D4. 呼叫 Gitea API 建立 PR（使用 token） + +token 從環境變數讀取，呼叫 Gitea 建立 PR： + +```bash +# 不可 echo 含 token 的指令；body 以檔案或變數帶入，輸出時遮蔽 token +curl -sS -X POST \ + -H "Authorization: token ${GITEA_TOKEN}" \ + -H "Content-Type: application/json" \ + "https:///api/v1/repos///pulls" \ + -d '{"head":"<當前分支>","base":"","title":"<標題>","body":"<描述>"}' +``` + +- **成功**：取回應中的 PR 連結／編號回報使用者。 +- **失敗**：顯示 API 回應的錯誤訊息供排查（**先遮蔽 token**）。常見錯誤：目標分支不存在、已有相同 head→base 的 PR、token 權限不足。 + +### D5. 完成通知 + 清除對話內文（重要：可能含 token） + +1. **通知使用者**：push 結果、PR 連結／編號、PR 描述採用哪種形式。 +2. **清除 AI 助理對話內文**：因為 push／API 過程可能使對話內文殘留 gitea token，**完成後務必清除對話內文／上下文**以免外洩： + - Claude Code：提示使用者執行 `/clear`（或依當前助理對等指令清空對話）。 + - 其他助理：執行各自清除對話／上下文的方式。 + - 在清除前，請再次確認輸出與 log 中沒有任何明文 token。 --- ## 總結 -提交完成後輸出： +各階段執行後輸出： - **階段 A**：已修復 N 條（依等級分佈）、待人工處理 M 條（列出原因）、findings.json 是否已清空。 - **階段 B**：建立了哪幾個 commit（type＋訊息＋檔數），或為何略過（`--no-commit` / 無變更）。 -- 提醒尚未 push；如需上 PR 由使用者決定。 +- **階段 C**：push 成功與否、用了哪種方式（認證管理器／token／使用者指定），遠端分支名。 +- **階段 D**：PR 連結／編號、目標分支、描述形式；並提醒已（或請使用者）清除對話內文以防 token 外洩。 --- ## 呼叫方式 -格式：`[--findings <路徑>] [--no-commit] [--yes]` — 全部可省略（findings 預設 `.gitea/ai-review/findings.json`）。 +格式：`[--findings <路徑>] [--target <目標分支>] [--pr-desc ] [--no-commit] [--no-pr] [--yes]` — +全部可省略（findings 預設 `.gitea/ai-review/findings.json`；目標分支省略時必問、不猜測）。token 一律由環境變數（如 `GITEA_TOKEN`）提供。 | 助理 | 呼叫 | | --- | --- | -| Claude Code / Antigravity | `/jsc:code-review-resolve`，或 `/jsc:code-review-resolve --findings .gitea/ai-review/findings.json --yes`、`/jsc:code-review-resolve --no-commit` | -| Codex | `$code-review-resolve`，或 `$code-review-resolve --findings .gitea/ai-review/findings.json --yes`，或用 `/skills` 選單 | -| OpenCode | 描述需求（如「讀 .gitea/ai-review/findings.json 依嚴重度逐條修好，清空該檔，再把工作區變更依 conventional commit 分類提交」）自動觸發 | +| Claude Code / Antigravity | `/jsc:code-review-resolve`，或 `/jsc:code-review-resolve --target develop --pr-desc full --yes`、`/jsc:code-review-resolve --no-pr`、`/jsc:code-review-resolve --no-commit` | +| Codex | `$code-review-resolve`，或 `$code-review-resolve --target develop --pr-desc simple --yes`，或用 `/skills` 選單 | +| OpenCode | 描述需求（如「讀 .gitea/ai-review/findings.json 依嚴重度逐條修好、清空該檔，把工作區變更依 conventional commit 分類提交，push 後對 develop 發 PR（完整版描述）」）自動觸發 |