Compare commits
82
Commits
12bdc7807a
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9d8ac26a3b | ||
|
|
ec038ab4fc | ||
|
|
db637dbab6 | ||
|
|
56241a0a50 | ||
|
|
0cd1b12147 | ||
|
|
3a760a462e | ||
|
|
ae745a0ad4 | ||
|
|
80d24ee3fd | ||
|
|
54f98d9b97 | ||
|
|
0296c5e7a3 | ||
|
|
cdf543afc2 | ||
|
|
c9a422caae | ||
|
|
c288dd3c09 | ||
|
|
729e6e794a | ||
|
|
377121d1c5 | ||
|
|
caf4638f38 | ||
|
|
62f599a02e | ||
|
|
726c92c208 | ||
|
|
36fd0c10a6 | ||
|
|
05def2e51d | ||
|
|
eeb3154420 | ||
|
|
8547f0af41 | ||
|
|
4fc33d4a69 | ||
|
|
7af96f1230 | ||
|
|
82458310a0 | ||
|
|
e8065f2d7c | ||
|
|
588f13881e | ||
|
|
33d6b7b95e | ||
|
|
feb294ee9a | ||
|
|
6de91ae30a | ||
|
|
1401638532 | ||
|
|
c8cd60461b | ||
|
|
8e73e864b5 | ||
|
|
d94f22ca06 | ||
|
|
6c702f30ce | ||
|
|
be96880022 | ||
|
|
a0baf50761 | ||
|
|
8419dbbca9 | ||
|
|
aad458ce8d | ||
|
|
2c9996b0e7 | ||
|
|
739d5ba937 | ||
|
|
7814e2edea | ||
|
|
fc39c1254d | ||
|
|
6e22907b0e | ||
|
|
0b464c5cdf | ||
|
|
099f17e067 | ||
|
|
186d69dfe6 | ||
|
|
38203f17f7 | ||
|
|
5bcd3a877d | ||
|
|
fcc8a96670 | ||
|
|
c8ecc10dcc | ||
|
|
c757bdc674 | ||
|
|
c98b06bca7 | ||
|
|
7f4eaeb258 | ||
|
|
68a3410f1e | ||
|
|
fc72f931a1 | ||
|
|
32e7832527 | ||
|
|
2d73b3121e | ||
|
|
b264709815 | ||
|
|
379750aa9b | ||
|
|
c9b2e12711 | ||
|
|
223dc0c532 | ||
|
|
c16762ced3 | ||
|
|
fcecc558b2 | ||
|
|
6d9bac4585 | ||
|
|
bff191e3d3 | ||
|
|
0e97646535 | ||
|
|
b935be26d9 | ||
|
|
5e47ea938f | ||
|
|
5633993d7f | ||
|
|
cd2cf2e35d | ||
|
|
a0b1a37ff9 | ||
|
|
e76775e703 | ||
|
|
5930254a5e | ||
|
|
26454b85f6 | ||
|
|
6b92ca9a30 | ||
|
|
a3a1346ae9 | ||
|
|
3a9819f6d8 | ||
|
|
4419257ebe | ||
|
|
a224cd7a1d | ||
|
|
09f0dffdb0 | ||
|
|
9adaf483f5 |
@@ -1,11 +1,11 @@
|
|||||||
{
|
{
|
||||||
"name": "jsc-plugins",
|
"name": "code",
|
||||||
"plugins": [
|
"plugins": [
|
||||||
{
|
{
|
||||||
"name": "jsc",
|
"name": "jsc-code",
|
||||||
"source": {
|
"source": {
|
||||||
"source": "url",
|
"source": "url",
|
||||||
"url": "https://gitea.jsc.idv.tw/plugins/template.git"
|
"url": "https://gitea.jsc.idv.tw/plugins/code.git"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -1,14 +1,14 @@
|
|||||||
{
|
{
|
||||||
"name": "jsc-plugins",
|
"name": "code",
|
||||||
"description": "JSC 跨 AI 助理共用 skills 的 Claude Code marketplace。",
|
"description": "JSC 程式碼工作流 skills 的 Claude Code marketplace,涵蓋 Gitea findings 修復/PR 流程、Gitea 議題 TODO 彙整與逐項實作、C# / .NET NuGet 套件更新、Gitea 專案批次同步與 action / Dockerfile 標準化。",
|
||||||
"owner": {
|
"owner": {
|
||||||
"name": "JSC"
|
"name": "JSC"
|
||||||
},
|
},
|
||||||
"plugins": [
|
"plugins": [
|
||||||
{
|
{
|
||||||
"name": "jsc",
|
"name": "jsc-code",
|
||||||
"source": "./",
|
"source": "./",
|
||||||
"description": "JSC 共用 skills(跨 AI 助理)"
|
"description": "JSC 程式碼工作流 skills:Gitea AI review findings 修復與 PR 流程、Gitea 議題 TODO 彙整與逐項實作、C# / .NET NuGet 套件更新、Gitea 專案批次同步、action / Dockerfile 標準化。"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "jsc",
|
"name": "jsc-code",
|
||||||
"version": "0.1.0",
|
"version": "0.0.3",
|
||||||
"description": "JSC 跨 AI 助理共用 plugin 模板(Claude Code / Codex / Antigravity / OpenCode)。所有 skills 以 SKILL.md 為共通標準,於 Claude Code 以 /jsc: 前綴呼叫。",
|
"description": "JSC 程式碼工作流 plugin(Claude Code / Codex / Antigravity / OpenCode),提供 Gitea AI review findings 修復/PR 流程、Gitea 議題 TODO 彙整與逐項實作、C# / .NET NuGet 套件更新、Gitea 專案批次同步,以及 action / Dockerfile 標準化流程;於 Claude Code 以 /jsc-code: 前綴呼叫。",
|
||||||
"skills": "./skills",
|
"skills": "./skills",
|
||||||
"author": {
|
"author": {
|
||||||
"name": "JSC"
|
"name": "JSC"
|
||||||
},
|
},
|
||||||
"homepage": "https://gitea.jsc.idv.tw/plugins/template",
|
"homepage": "https://gitea.jsc.idv.tw/plugins/code",
|
||||||
"repository": "https://gitea.jsc.idv.tw/plugins/template.git",
|
"repository": "https://gitea.jsc.idv.tw/plugins/code.git",
|
||||||
"keywords": ["template", "skills", "cross-tool", "jsc"]
|
"keywords": ["code-review", "git-diff", "gitea", "nuget", "docker", "skills", "jsc"]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "jsc",
|
"name": "jsc-code",
|
||||||
"version": "0.1.0",
|
"version": "0.0.3",
|
||||||
"description": "JSC 跨 AI 助理共用 plugin 模板。所有 skills 以 SKILL.md 為共通標準。",
|
"description": "JSC 程式碼工作流 plugin,提供 Gitea AI review findings 修復/PR 流程、Gitea 議題 TODO 彙整與逐項實作、C# / .NET NuGet 套件更新、Gitea 專案批次同步,以及 action / Dockerfile 標準化流程。",
|
||||||
"skills": "./skills"
|
"skills": "./skills"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# jsc — 共用 Skills(跨 AI 助理)
|
# jsc-code — 共用 Skills(跨 AI 助理)
|
||||||
|
|
||||||
本 repo 是一組以 **Agent Skills(`SKILL.md`)** 標準撰寫的共用 skills,可同時被 Claude Code、Codex、Antigravity、OpenCode 使用。
|
本 repo 是一組以 **Agent Skills(`SKILL.md`)** 標準撰寫的共用 skills,可同時被 Claude Code、Codex、Antigravity、OpenCode 使用。
|
||||||
|
|
||||||
@@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
- 所有可用的 skills 位於本 repo 的 `skills/<name>/SKILL.md`。
|
- 所有可用的 skills 位於本 repo 的 `skills/<name>/SKILL.md`。
|
||||||
- 在處理任務前,先比對使用者需求與各 skill `SKILL.md` frontmatter 的 `description`,若相符請載入並依其步驟執行。
|
- 在處理任務前,先比對使用者需求與各 skill `SKILL.md` frontmatter 的 `description`,若相符請載入並依其步驟執行。
|
||||||
- **呼叫慣例**:在 Claude Code 與 Antigravity 中,這些 skill 以 `/jsc:<name>` 呼叫;Codex 以 `$<name>`、OpenCode 由模型依描述自動觸發 — 兩者沒有 `/jsc:` 前綴,不需強制加。
|
- **呼叫慣例**:在 Claude Code 與 Antigravity 中,這些 skill 以 `/jsc-code:<name>` 呼叫;Codex 以 `$<name>`、OpenCode 由模型依描述自動觸發 — 兩者沒有 `/jsc-code:` 前綴,不需強制加。
|
||||||
- 完整清單與每個 skill 的用途,請見 `README.md` 的「Skills 目錄」。
|
- 完整清單與每個 skill 的用途,請見 `README.md` 的「Skills 目錄」。
|
||||||
|
|
||||||
## 慣例
|
## 慣例
|
||||||
|
|||||||
@@ -1,50 +1,60 @@
|
|||||||
# jsc — 跨 AI 助理 Plugin 模板
|
# jsc-code — 跨 AI 助理程式碼工作流 Plugin
|
||||||
|
|
||||||
一個可同時被 **Claude Code、Codex、Antigravity、OpenCode** 安裝的 plugin 模板。
|
一個可同時被 **Claude Code、Codex、Antigravity、OpenCode、GitHub Copilot** 使用的 plugin,提供一組以 **程式碼工作流** 為核心的 skills:
|
||||||
|
**Gitea AI review findings 修復、分類提交、push 與 PR 建立流程**、**Gitea 議題 TODO 彙整與逐項實作流程**、**C# / .NET NuGet 套件更新流程**、**Gitea 專案批次同步**、**`TARGET.md` 每日排程執行與 PR 流程**,以及 **action / Dockerfile 標準化流程**。
|
||||||
核心是以 [Agent Skills(`SKILL.md`)](https://agentskills.io) 標準撰寫的共用 skills(唯一真實來源放在 `skills/`),
|
核心是以 [Agent Skills(`SKILL.md`)](https://agentskills.io) 標準撰寫的共用 skills(唯一真實來源放在 `skills/`),
|
||||||
搭配各助理各自的 plugin manifest,讓**同一個 repo** 可用各家**原生 plugin CLI** 安裝。
|
搭配各助理各自的 plugin manifest,讓**同一個 repo** 可用各家**原生 plugin CLI** 安裝。
|
||||||
在 Claude Code 與 Antigravity 中,skill 以 **`/jsc:` 前綴**呼叫(例如 `/jsc:hello`)。
|
plugin 名為 `jsc-code`,在 Claude Code 與 Antigravity 中 skill 以 **`/jsc-code:` 前綴**呼叫(例如 `/jsc-code:issues`)。
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 前綴與呼叫方式
|
## 前綴與呼叫方式
|
||||||
|
|
||||||
| 助理 | 安裝方式 | 呼叫 | `/jsc:` 前綴 |
|
| 助理 | 安裝方式 | 呼叫 | `/jsc-code:` 前綴 |
|
||||||
| --- | --- | --- | --- |
|
| --- | --- | --- | --- |
|
||||||
| Claude Code | `claude plugin`(marketplace) | `/jsc:<name>` 或自動觸發 | ✅ |
|
| Claude Code | `claude plugin`(marketplace) | `/jsc-code:<name>` 或自動觸發 | ✅ |
|
||||||
| Codex | `codex plugin`(marketplace) | `$<name>` 或 `/skills` 選單 | ❌(用 `$name`) |
|
| Codex | `codex plugin`(marketplace) | `$<name>` 或 `/skills` 選單 | ❌(用 `$name`) |
|
||||||
| Antigravity | `agy plugin install` | `/jsc:<name>` 或自動觸發 | ✅ |
|
| Antigravity | `agy plugin install` | `/jsc-code:<name>` 或自動觸發 | ✅ |
|
||||||
| OpenCode | skills 目錄(複製/clone) | 描述需求自動觸發 | ❌(依名稱) |
|
| OpenCode | skills 目錄(複製/clone) | 描述需求自動觸發 | ❌(依名稱) |
|
||||||
|
| GitHub Copilot CLI | `copilot plugin`(marketplace) | 自然語言或 plugin skills | ❌(無 `/jsc-code:` 前綴) |
|
||||||
|
|
||||||
> Codex 不支援自訂前綴(skill 以 `$name` 呼叫);OpenCode 由模型依描述自動呼叫。兩者皆**不強制**前綴。
|
> Codex 不支援自訂前綴(skill 以 `$name` 呼叫);OpenCode 由模型依描述自動呼叫;Copilot CLI 透過原生 plugin 安裝後以自然語言或 plugin skills 使用。三者皆**不強制**前綴。
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 目錄結構
|
## 目錄結構
|
||||||
|
|
||||||
同一個 repo 同時帶四種 manifest,彼此以路徑隔離、互不干擾;四家都讀同一份 `skills/`。
|
同一個 repo 同時帶四種 manifest,彼此以路徑隔離、互不干擾;各助理都讀同一份 `skills/`。
|
||||||
|
|
||||||
```
|
```
|
||||||
template/
|
code/
|
||||||
├── .claude-plugin/
|
├── .claude-plugin/
|
||||||
│ ├── plugin.json # Claude 外掛定義(name: "jsc")
|
│ ├── plugin.json # Claude 外掛定義(name: "jsc-code")
|
||||||
│ └── marketplace.json # Claude marketplace(name: "jsc-plugins",source 指向本 repo)
|
│ └── marketplace.json # Claude marketplace(name: "code",source 指向本 repo)
|
||||||
├── .codex-plugin/
|
├── .codex-plugin/
|
||||||
│ └── plugin.json # Codex 外掛定義(name: "jsc",skills: "./skills")
|
│ └── plugin.json # Codex 外掛定義(name: "jsc-code",skills: "./skills")
|
||||||
├── .agents/plugins/
|
├── .agents/plugins/
|
||||||
│ └── marketplace.json # Codex marketplace(name: "jsc-plugins",url source 指向本 repo)
|
│ └── marketplace.json # Codex marketplace(name: "code",url source 指向本 repo)
|
||||||
├── plugin.json # Antigravity 外掛定義(name: "jsc",skills: "./skills/")
|
├── plugin.json # Antigravity 外掛定義(name: "jsc-code",skills: "./skills/")
|
||||||
├── skills/ # ★ 唯一真實來源:所有 skills
|
├── skills/ # ★ 唯一真實來源:所有 skills
|
||||||
│ └── hello/SKILL.md
|
│ ├── review-resolve/ # 解決 findings.json + 分類提交 + push + 發 PR
|
||||||
|
│ ├── issues/ # 彙整議題 TODO(影響範圍小→大)+ 逐項實作 + 留言進度
|
||||||
|
│ ├── nuget/ # C# / .NET NuGet 套件更新 + build 驗證
|
||||||
|
│ ├── sync/ # 依擁有者批次 clone/更新 Gitea 專案
|
||||||
|
│ ├── action-docker/ # action 容器化(Node 主程式)+ 串接 funcs
|
||||||
|
│ ├── action-composite/ # composite action 標準化 + 串接 funcs
|
||||||
|
│ ├── action-node/ # Node(JS)action 標準化(ncc 打包)+ 串接 funcs
|
||||||
|
│ ├── image/ # Dockerfile 整理成六步流程 + 串接 funcs
|
||||||
|
│ └── target/ # TARGET.md 每日 00:00 排程執行 + 分類提交 + push develop + PR
|
||||||
├── AGENTS.md # 跨助理共用指引
|
├── AGENTS.md # 跨助理共用指引
|
||||||
└── README.md
|
└── README.md
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 安裝 / 更新 / 移除(各家原生 plugin CLI)
|
## 安裝 / 更新 / 移除(各助理)
|
||||||
|
|
||||||
> 指令中的 repo 網址換成你的:`https://gitea.jsc.idv.tw/plugins/template.git`
|
> 指令中的 repo 網址換成你的:`https://gitea.jsc.idv.tw/plugins/code.git`
|
||||||
>
|
>
|
||||||
> **Claude / Codex 從 git URL 安裝(會 clone 遠端),請先把本 repo `push` 到 gitea。**
|
> **Claude / Codex 從 git URL 安裝(會 clone 遠端),請先把本 repo `push` 到 gitea。**
|
||||||
> **Antigravity 的 `agy plugin install <url>` 目前只支援 github.com**;gitea 請改用「clone + 本地路徑」(見 Antigravity 節)。
|
> **Antigravity 的 `agy plugin install <url>` 目前只支援 github.com**;gitea 請改用「clone + 本地路徑」(見 Antigravity 節)。
|
||||||
@@ -54,40 +64,40 @@ template/
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 安裝
|
# 安裝
|
||||||
claude plugin marketplace add https://gitea.jsc.idv.tw/plugins/template.git
|
claude plugin marketplace add https://gitea.jsc.idv.tw/plugins/code.git
|
||||||
claude plugin install jsc@template
|
claude plugin install jsc-code@code
|
||||||
|
|
||||||
# 更新
|
# 更新
|
||||||
claude plugin marketplace update template
|
claude plugin marketplace update code
|
||||||
claude plugin update jsc@template
|
claude plugin update jsc-code@code
|
||||||
|
|
||||||
# 移除
|
# 移除
|
||||||
claude plugin uninstall jsc@template
|
claude plugin uninstall jsc-code@code
|
||||||
claude plugin marketplace remove template
|
claude plugin marketplace remove code
|
||||||
```
|
```
|
||||||
|
|
||||||
- 工作階段內 slash 版(等價):把 `claude plugin` 換成 `/plugin`。
|
- 工作階段內 slash 版(等價):把 `claude plugin` 換成 `/plugin`。
|
||||||
- 本機開發(免 push):`claude plugin marketplace add C:\Users\h3285\source\repos.plugins\template`(本地路徑)後再 install。
|
- 本機開發(免 push):`claude plugin marketplace add C:\Users\h3285\source\repos.plugins\code`(本地路徑)後再 install。
|
||||||
- **呼叫**:`/jsc:<name>`(例 `/jsc:hello`)。
|
- **呼叫**:`/jsc-code:<name>`(例 `/jsc-code:issues`)。
|
||||||
|
|
||||||
### Codex
|
### Codex
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 安裝
|
# 安裝
|
||||||
codex plugin marketplace add https://gitea.jsc.idv.tw/plugins/template.git
|
codex plugin marketplace add https://gitea.jsc.idv.tw/plugins/code.git
|
||||||
codex plugin add jsc@template
|
codex plugin add jsc-code@code
|
||||||
|
|
||||||
# 更新(重新抓取 marketplace 的 git 快照)
|
# 更新(重新抓取 marketplace 的 git 快照)
|
||||||
codex plugin marketplace upgrade template
|
codex plugin marketplace upgrade code
|
||||||
|
|
||||||
# 移除
|
# 移除
|
||||||
codex plugin remove jsc@template
|
codex plugin remove jsc-code@code
|
||||||
codex plugin marketplace remove template
|
codex plugin marketplace remove code
|
||||||
```
|
```
|
||||||
|
|
||||||
- 安裝 token `jsc@template` = plugin 名(`.codex-plugin/plugin.json` 的 `name`)@ marketplace 名(`.agents/plugins/marketplace.json` 的 `name`)。
|
- 安裝 token `jsc-code@code` = plugin 名(`.codex-plugin/plugin.json` 的 `name`)@ marketplace 名(`.agents/plugins/marketplace.json` 的 `name`)。
|
||||||
- 本 repo 的 Codex marketplace 以 `url` 來源指向自己,故 Codex **一律從 gitea 安裝**(需先 push);安裝後重啟 Codex。
|
- 本 repo 的 Codex marketplace 以 `url` 來源指向自己,故 Codex **一律從 gitea 安裝**(需先 push);安裝後重啟 Codex。
|
||||||
- **呼叫**:`$<name>`(例 `$hello`),或用 `/skills` 選單。
|
- **呼叫**:`$<name>`(例 `$issues`),或用 `/skills` 選單。
|
||||||
|
|
||||||
### Antigravity(`agy`)
|
### Antigravity(`agy`)
|
||||||
|
|
||||||
@@ -95,21 +105,21 @@ codex plugin marketplace remove template
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 安裝:clone 後用本地路徑
|
# 安裝:clone 後用本地路徑
|
||||||
git clone https://gitea.jsc.idv.tw/plugins/template.git ~/plugins/template
|
git clone https://gitea.jsc.idv.tw/plugins/code.git ~/plugins/code
|
||||||
agy plugin install ~/plugins/template
|
agy plugin install ~/plugins/code
|
||||||
|
|
||||||
# 更新(agy 無 update 子指令 → git pull 後重裝)
|
# 更新(agy 無 update 子指令 → git pull 後重裝)
|
||||||
git -C ~/plugins/template pull
|
git -C ~/plugins/code pull
|
||||||
agy plugin uninstall jsc
|
agy plugin uninstall jsc-code
|
||||||
agy plugin install ~/plugins/template
|
agy plugin install ~/plugins/code
|
||||||
|
|
||||||
# 移除
|
# 移除
|
||||||
agy plugin uninstall jsc
|
agy plugin uninstall jsc-code
|
||||||
```
|
```
|
||||||
|
|
||||||
- 若把 skills 放到 GitHub,則可直接 `agy plugin install https://github.com/<owner>/<repo>`。
|
- 若把 skills 放到 GitHub,則可直接 `agy plugin install https://github.com/<owner>/<repo>`。
|
||||||
- 其他:`agy plugin list`、`agy plugin enable jsc` / `disable jsc`、`agy plugin validate <path>`。安裝後重啟工作階段。
|
- 其他:`agy plugin list`、`agy plugin enable jsc-code` / `disable jsc-code`、`agy plugin validate <path>`。安裝後重啟工作階段。
|
||||||
- **呼叫**:`/jsc:<name>`(例 `/jsc:hello`)或依描述自動觸發。
|
- **呼叫**:`/jsc-code:<name>`(例 `/jsc-code:issues`)或依描述自動觸發。
|
||||||
|
|
||||||
### OpenCode
|
### OpenCode
|
||||||
|
|
||||||
@@ -118,39 +128,62 @@ OpenCode 會讀 `~/.config/opencode/skills/`(也會讀 `~/.claude/skills/`、`
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 安裝
|
# 安裝
|
||||||
git clone https://gitea.jsc.idv.tw/plugins/template.git ~/plugins/template
|
git clone https://gitea.jsc.idv.tw/plugins/code.git ~/plugins/code
|
||||||
mkdir -p ~/.config/opencode/skills
|
mkdir -p ~/.config/opencode/skills
|
||||||
cp -r ~/plugins/template/skills/* ~/.config/opencode/skills/
|
cp -r ~/plugins/code/skills/* ~/.config/opencode/skills/
|
||||||
|
|
||||||
# 更新
|
# 更新
|
||||||
git -C ~/plugins/template pull
|
git -C ~/plugins/code pull
|
||||||
cp -r ~/plugins/template/skills/* ~/.config/opencode/skills/
|
cp -r ~/plugins/code/skills/* ~/.config/opencode/skills/
|
||||||
|
|
||||||
# 移除
|
# 移除
|
||||||
rm -rf ~/.config/opencode/skills/hello
|
rm -rf ~/.config/opencode/skills/{review-resolve,issues,nuget,sync,action-docker,action-composite,action-node,image,target}
|
||||||
```
|
```
|
||||||
|
|
||||||
> **Windows PowerShell**:`cp -r A B` → `Copy-Item A B -Recurse -Force`、`rm -rf X` → `Remove-Item X -Recurse -Force`、`~` → `$HOME`。
|
> **Windows PowerShell**:`cp -r A B` → `Copy-Item A B -Recurse -Force`、`rm -rf X` → `Remove-Item X -Recurse -Force`、`~` → `$HOME`。
|
||||||
|
|
||||||
- **呼叫**:直接描述需求,模型會依 skill 描述自動透過 skill 工具呼叫。
|
- **呼叫**:直接描述需求,模型會依 skill 描述自動透過 skill 工具呼叫。
|
||||||
|
|
||||||
|
### GitHub Copilot CLI
|
||||||
|
|
||||||
|
Copilot CLI 支援與 Claude Code 類似的原生 plugin / marketplace 指令,可直接從 marketplace 安裝、更新與移除本 plugin。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 安裝
|
||||||
|
copilot plugin marketplace add https://gitea.jsc.idv.tw/plugins/code.git
|
||||||
|
copilot plugin install jsc-code@code
|
||||||
|
|
||||||
|
# 更新
|
||||||
|
copilot plugin marketplace update code
|
||||||
|
copilot plugin update jsc-code@code
|
||||||
|
|
||||||
|
# 移除
|
||||||
|
copilot plugin uninstall jsc-code@code
|
||||||
|
copilot plugin marketplace remove code
|
||||||
|
```
|
||||||
|
|
||||||
|
- 安裝 token `jsc-code@code` = plugin 名(plugin manifest 的 `name`)@ marketplace 名。
|
||||||
|
- `copilot plugin marketplace add` 支援 GitHub `owner/repo`、git URL 與本地路徑;Gitea repo 可用上方 HTTPS URL。
|
||||||
|
- **呼叫**:在 Copilot CLI 中用自然語言描述需求,例如 `copilot -i "請使用 issues 處理 plugins/code 的 12、15 號議題"`。
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 用 CLI 直接執行 skill(headless / 一次性)
|
## 用 CLI 直接執行 skill(headless / 一次性)
|
||||||
|
|
||||||
安裝好之後,不必進互動介面,一行指令就能叫某個 skill 跑完並印出結果:
|
安裝好之後,不必進互動介面,一行指令就能叫某個 skill 跑完並印出結果:
|
||||||
|
|
||||||
| 助理 | headless 指令 | 執行 `hello` skill |
|
| 助理 | headless 指令 | 執行 `issues` skill |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| Claude Code | `claude -p "<prompt>"` | `claude -p "/jsc:hello"` |
|
| Claude Code | `claude -p "<prompt>"` | `claude -p "/jsc-code:issues --tool api --repo plugins/code --issues 12,15 --yes"` |
|
||||||
| Codex | `codex exec "<prompt>"` | `codex exec '$hello'` |
|
| Codex | `codex exec "<prompt>"` | `codex exec '$issues --tool api --repo plugins/code --issues 12,15 --yes'` |
|
||||||
| Antigravity | `agy -p "<prompt>"` | `agy -p "/jsc:hello"` |
|
| Antigravity | `agy -p "<prompt>"` | `agy -p "/jsc-code:issues --tool api --repo plugins/code --issues 12,15 --yes"` |
|
||||||
| OpenCode | `opencode run "<message>"` | `opencode run "用 hello skill 打個招呼"` |
|
| OpenCode | `opencode run "<message>"` | `opencode run "讀 plugins/code 的 12、15 號議題,整理 TODO 並逐項實作、留言進度"` |
|
||||||
|
| GitHub Copilot CLI | `copilot -p "<message>"` | `copilot -p "讀 plugins/code 的 12、15 號議題,整理 TODO 並逐項實作、留言進度"` |
|
||||||
|
|
||||||
- Claude / Antigravity 支援 `/jsc:` 前綴,直接 `-p "/jsc:<name>"` 即可。
|
- Claude / Antigravity 支援 `/jsc-code:` 前綴,直接 `-p "/jsc-code:<name>"` 即可。
|
||||||
- Codex 以 `$<name>` 觸發;在 shell 請用**單引號**避免 `$` 被展開:`codex exec '$hello'`。
|
- Codex 以 `$<name>` 觸發;在 shell 請用**單引號**避免 `$` 被展開:`codex exec '$issues …'`。
|
||||||
- OpenCode 沒有前綴,用自然語言描述需求,模型會自動透過 skill 工具呼叫。
|
- OpenCode 與 Copilot 沒有前綴,用自然語言描述需求;Copilot CLI 會讀取已安裝 plugin 提供的 skills。
|
||||||
- 帶引數就接在後面,例如 `claude -p "/jsc:hello 參數"`、`codex exec '$hello 參數'`。
|
- 帶引數就接在後面,例如 `claude -p "/jsc-code:issues --issues 12"`、`codex exec '$issues --issues 12'`。
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -161,13 +194,95 @@ rm -rf ~/.config/opencode/skills/hello
|
|||||||
|
|
||||||
<!-- JSC-SKILLS:START -->
|
<!-- JSC-SKILLS:START -->
|
||||||
|
|
||||||
### `hello`
|
### `review-resolve`
|
||||||
|
|
||||||
範例 skill,用來驗證 jsc plugin 是否安裝成功,也是新增 skill 的範本。當使用者輸入 hello、想測試 plugin、或想看 skill 模板長什麼樣子時觸發;回覆一句問候並簡述此 plugin 的用途。
|
五階段:**(A Git 同步)** 先 `fetch`,務必檢查目前分支的線上分支是否存在;存在則留在目前分支更新到最新,不存在則依序切換到遠端 `develop`/`master` 並更新到最新,找不到後備分支則停止;pull 發生衝突時告知並嘗試安全解衝突;只有來源分支與 PR 目標分支相同時,才必須從該分支建立新的工作分支,後續修復、commit、push 與 PR `head` 都使用新分支。**(B 解決)** 讀工作目錄 `.gitea/ai-review/findings.json`(Gitea AI review 產出的問題清單),依嚴重等級 **🔴 嚴重 → 🟠 高 → 🟡 中 → 🔵 低** 由高到低**逐條修復**程式碼問題或登記誤報(無法安全自動修復者標「待人工處理」不硬改),已解決或已登記誤報者才自 `findings.json` 移除。**(C 提交)** 分析工作區**所有**變更,依異動內容歸類為 `feat`/`fix`/`docs`/`style`/`refactor`/`perf`/`test`/`chore`/`revert`,**每個 type 各自一個 commit**,訊息為「`type(範圍): 一句總結`」格式,**括號內的範圍須對應實際異動的功能/模組**(例 `feat(使用者登入): 新增帳密登入流程`、`perf(物件查詢): 改用批次查詢降低 DB 往返`,而非 `feat(新增功能)` 這類重述 type 的詞)。**(D 推送)** push 當前分支:先用**認證管理器**、失敗改用 **token**、再失敗**詢問使用者**。**(E 開 PR)** 用 token 透過 **Gitea API** 對目標分支發 PR(**目標分支不明必須詢問、不可猜測**),PR 描述可選**完整版**(重新分析 `git diff` 總結)/**簡單版**(逐條列 commit 訊息)/**使用者輸入**;完成後因內文可能含 gitea token,**提醒並清除 AI 助理對話內文**。除非遇到必要決策,否則依自動執行原則直接處理;token 一律由環境變數(如 `GITEA_TOKEN`)提供,全程不明文輸出。
|
||||||
|
|
||||||
- **Claude Code / Antigravity**:`/jsc:hello`
|
參數:`[--findings <findings.json 路徑>] [--target <目標分支>] [--pr-desc <full|simple|自訂文字>] [--no-commit] [--no-pr] [--yes]`(findings 省略時預設 `.gitea/ai-review/findings.json`;`--target` 省略且需要開 PR 時必問;`--no-commit` 只修復不提交;`--no-pr` 推送但不開 PR;`--yes` 略過確認)。
|
||||||
- **Codex**:`$hello`,或用 `/skills` 選單
|
|
||||||
- **OpenCode**:描述需求自動觸發
|
- **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**:`$review-resolve`,或 `$review-resolve --target develop --pr-desc simple --yes`,或用 `/skills` 選單
|
||||||
|
- **OpenCode**:描述需求(如「讀 .gitea/ai-review/findings.json 依嚴重度逐條修好、清空該檔,把工作區變更依 conventional commit 分類提交,push 後對 develop 發 PR(完整版描述)」)自動觸發
|
||||||
|
|
||||||
|
### `issues`
|
||||||
|
|
||||||
|
處理一或多個 Gitea 議題的實作流程,五階段:**(A 工具選擇)** 檢查 `tea` 與 `GITEA_TOKEN`,詢問要用 `tea` 或 Gitea REST API(**已選定則跳過**);**(B 確認專案)** 詢問議題所在專案 owner/repo,可用目前 repo 的 origin 當預設(**已知則跳過**);**(C 選擇議題)** 列出開啟中議題後詢問要處理的議題編號,**一個或多個**(**已提供則跳過**);**(D 彙整 TODO)** 讀取議題描述與所有留言、彙整需求,盤點既有 checklist 後整理 TODO 列表並依**影響範圍由小到大**(XS→XL)排序,既有 TODO **不足以達成議題需求時補上新 TODO 並附加到議題描述**的 `## TODO` 區塊;**(E 逐項實作)** 依排序實作每項 TODO 並驗證,**每完成一項就勾選描述 checkbox 並留言進度到議題**,全部完成後留下總結留言。**全程不建立任何草稿檔**(中間成果一律保存到議題描述或留言),輸出與留言**盡量使用表格與 Mermaid 圖**;commit/push/PR 不在自動範圍,由使用者另行指示。
|
||||||
|
|
||||||
|
參數:`[--tool <tea|api>] [--repo <owner/repo>] [--issues <編號,以逗號分隔>] [--host <gitea 主機>] [--yes]`(帶 `--tool`/`--repo`/`--issues` 時跳過對應詢問;`--yes` 略過一般確認)。
|
||||||
|
|
||||||
|
- **Claude Code / Antigravity**:`/jsc-code:issues`,或 `/jsc-code:issues --tool api --repo plugins/code --issues 12,15 --yes`
|
||||||
|
- **Codex**:`$issues`,或 `$issues --tool tea --repo plugins/code --issues 12`,或用 `/skills` 選單
|
||||||
|
- **OpenCode**:描述需求(如「讀 plugins/code 的 12、15 號議題,整理需求成 TODO 依影響範圍小到大排序、缺的補進議題描述,逐項實作、每完成一項留言進度」)自動觸發
|
||||||
|
|
||||||
|
### `nuget`
|
||||||
|
|
||||||
|
將 C# / .NET 專案的 NuGet 套件更新到最新可用版本。流程會先探測 `.sln` / `.slnx` / `.csproj` 與 `dotnet` 工具,執行 baseline `restore` / `build`,再**依專案分組列出所有 direct / transitive 套件**與目前版本、最新版本、參考來源。接著建立 `ProjectReference` graph:若當前專案所參考的上層專案已 direct reference 相同 NuGet 套件,且該套件會透過專案參考安全傳遞,便逐一移除重複 `PackageReference`;每移除一筆都立刻 `restore` / `build` 驗證,失敗即回復。最後逐一更新 direct 套件版本(支援 Central Package Management / `Directory.Packages.props`),**每更新一個套件就 restore/build 確認專案可正常編譯**;若最新版本編譯失敗,改從目前版本之後的最小可用版本逐版升級,直到遇到第一個編譯失敗版本,保留最後一個可編譯版本並記錄失敗點。
|
||||||
|
|
||||||
|
參數:`[<solution-or-project>] [--include-prerelease] [--no-dedupe] [--build <command>] [--yes]`(目標可為 `.sln`、`.slnx` 或 `.csproj`;`--include-prerelease` 允許 prerelease;`--no-dedupe` 略過重複參考清理;`--build` 覆寫驗證指令;`--yes` 略過一般確認但不略過必要決策)。
|
||||||
|
|
||||||
|
- **Claude Code / Antigravity**:`/jsc-code:nuget`,或 `/jsc-code:nuget MySolution.sln --include-prerelease`
|
||||||
|
- **Codex**:`$nuget`,或 `$nuget src/App/App.csproj --build "dotnet build App.sln -c Release"`,或用 `/skills` 選單
|
||||||
|
- **OpenCode**:描述需求(如「把這個 .NET solution 的 NuGet 都更新到最新,先清掉 ProjectReference 已提供的重複套件,每更新一包就 build」)自動觸發
|
||||||
|
|
||||||
|
### `sync`
|
||||||
|
|
||||||
|
透過 `GITEA_TOKEN` 把使用者有讀取權限的 Gitea 專案批次 clone 到本機並依擁有者分類。流程會先確認 token、決定 gitea 主機與目標根目錄(預設家目錄),再以 token 分頁呼叫 `GET /api/v1/user/repos` 取回**所有有讀取權限**的專案、依 `owner` 分組(預設排除 fork);接著列出所有擁有者讓使用者**多選**(帶 `--owner` 則跳過詢問),列出選定擁有者底下的專案後,於 `<根目錄>/<擁有者>/<專案名>` 逐一處理:**不存在則 clone**(HTTPS+token,clone 後還原乾淨 origin;或 `--ssh`),**已存在則 `fetch` → 切到 develop(再退而 master)→ `pull --ff-only` 更新到最新**。全程唯讀(不 push、不改遠端),工作區有未提交變更的專案會略過而非強制覆蓋;token 一律由環境變數提供、不寫死也不印出。
|
||||||
|
|
||||||
|
參數:`[--target-dir <根目錄>] [--owner <擁有者,以逗號分隔>] [--host <gitea 主機>] [--include-forks] [--ssh] [--yes]`(根目錄預設家目錄;`--owner` 預先指定擁有者並跳過多選;`--host` 指定 gitea 主機;`--include-forks` 納入 fork;`--ssh` 改用 SSH clone;`--yes` 略過一般確認但不略過擁有者多選)。
|
||||||
|
|
||||||
|
- **Claude Code / Antigravity**:`/jsc-code:sync`,或 `/jsc-code:sync --owner plugins --target-dir ~/work`、`/jsc-code:sync --include-forks --ssh`
|
||||||
|
- **Codex**:`$sync`,或 `$sync --owner plugins --target-dir ~/work`,或用 `/skills` 選單
|
||||||
|
- **OpenCode**:描述需求(如「用 GITEA_TOKEN 取得我有讀取權限的所有 Gitea 專案,依擁有者分組讓我多選,把選定擁有者的專案 clone 到家目錄;已存在的切到 develop/master 更新到最新」)自動觸發
|
||||||
|
|
||||||
|
### `action-docker`
|
||||||
|
|
||||||
|
把 Gitea/GitHub「Docker 容器 action」專案標準化為 **Node 主程式+容器化**,再串接文件化流程。五階段:(A) 找出 action 專案、讀 `action.yml`/`action.yaml` 的 `name`/`description`、判斷主程式語言;(B) 主程式**非 Node 則保守改寫為 Node**(高風險,先以 AskUserQuestion 確認,保留對外行為),並把**主程式依賴鏈**的 `.js` 集中到 **`src/`**(工具設定檔與測試目錄不搬)、同步更新 `require`/`import` 路徑、`package.json` 與 `action.yml`(`runs` 只設 `using: docker`+`image: Dockerfile`,**不設相對路徑的 `entrypoint`**,入口由 Dockerfile 的絕對路徑 `ENTRYPOINT` 決定);(C) 產生 `entrypoint.sh`,**啟動 node 前先輸出 action 名稱/用途/更新時間**(Asia/Taipei `yyyy/MM/dd HH:mm:ss`)再 `exec node`;(D) 依**六步流程**(參數處理 → 安裝套件 → 複製檔案 → 執行程序 → 縮小映像檔 → 設定入口)產生**使用最新 LTS node 版本(固定 major tag)**的 `Dockerfile`,**每步內容依主程式(`src/`)實作量身決定**(先盤點相依/是否需 build/OS 層相依/入口檔並產生 `.dockerignore`,再填對應步驟,用不到的不硬塞),預設 build 基底為當前 LTS(如 `node:22`)、runtime 對應 `-slim`(如 `node:22-slim`),**多階段建置逐項明列必要產物**(不整包 COPY)縮小映像,`ENTRYPOINT` 指向 `entrypoint.sh`(絕對路徑);(E) 對整個專案**完整執行 `/jsc-doc:funcs`**(function 文件、`entrypoint.sh`/`Dockerfile` 逐行註解、重建 README)。開發中需要新參數時依**參數來源優先序**處理:優先取用 runner 注入容器的 `GITHUB_*`/`GITEA_*` 執行期環境變數(即 `gitea.*`/`github.*` context 的同源資訊;docker action 的 `action.yml` 幾乎只有 `inputs`/`env` context 可用),無法取得才經使用者同意**新增 `inputs`**(容器內讀 `INPUT_*`);`secrets`/`vars` context 在 docker action 內**一律視為不可用**(GitHub 官方文件僅記載 `inputs` context、runner 不注入 secrets;Gitea 行為無保證),需要時宣告為 `inputs` 由呼叫端 workflow 以 `with:` 傳入,未經同意不擅改 `inputs`/`outputs` 契約。目錄沒有 `action.yml` 時可走**問答式從零建立**(收集名稱/輸入輸出/執行目標後產生 docker `action.yml` 與 `src/index.js` 骨架,再接後續階段)。skill 各檔的「更新時間」於最終階段(funcs 完成後)**統一同步為同一時間戳**。
|
||||||
|
|
||||||
|
參數:`[--action-dir <action 根目錄>] [--node-version <node tag>] [--main <主程式檔>]`(根目錄預設目前工作目錄;node 版本預設最新;主程式自動判斷)。
|
||||||
|
|
||||||
|
- **Claude Code / Antigravity**:`/jsc-code:action-docker`,或 `/jsc-code:action-docker --action-dir ~/work/my-action --node-version 22`
|
||||||
|
- **Codex**:`$action-docker`,或 `$action-docker --action-dir ~/work/my-action`,或用 `/skills` 選單
|
||||||
|
- **OpenCode**:描述需求(如「把這個 action 主程式改成 node、主程式相關 js 收進 src/,產生會先輸出 action 名稱/用途/更新時間再啟動 node 的 entrypoint.sh、用最新 LTS node 版本的 Dockerfile,最後跑 funcs 補文件並重建 README」)自動觸發
|
||||||
|
|
||||||
|
### `action-composite`
|
||||||
|
|
||||||
|
把 Gitea/GitHub「composite action」專案標準化,再串接文件化流程。四階段:(A) 找出 action 專案、讀 `action.yml`/`action.yaml` 的 `name`/`description`/`runs`、判斷是否為 composite;(B) **已是 composite 則保留既有 `steps`**,非 composite(JS/Docker)則**保守確認後對齊**為 composite(高風險先以 AskUserQuestion 確認;JS action 轉換須補 `INPUT_*` env 映射與 `outputs.value` 轉接以保留 `inputs`/`outputs` 契約;Docker 行為無法等價塞入時標「需人工確認」並建議改用 `action-docker`);(C) 在 `runs.steps` **最前面注入啟動橫幅 step**,輸出 action **名稱/用途/更新時間**(Asia/Taipei `yyyy/MM/dd HH:mm:ss`,固定字串),並於 `action.yml` 開頭補用途/更新時間註解區塊(既有橫幅 step 則更新而非重插);(D) 對整個專案**完整執行 `/jsc-doc:funcs`**(`action.yml` 與被引用腳本逐行註解、function 文件、重建 README)。開發中需要新參數時依**參數來源優先序**處理:優先取用 `${{ gitea.* }}`/`${{ github.* }}` context(Gitea 中兩者互為別名,composite step 內可直接使用、`run` 腳本內可讀同源 `$GITHUB_*` 環境變數),無法取得才經使用者同意**新增 `inputs`**;`secrets`/`vars` context 在 composite action 內**一律視為不可用**(GitHub 官方明文限制;Gitea act_runner 未嚴格檢查 context 可用性、行為無保證),需要時宣告為 `inputs` 由呼叫端 workflow 以 `with:` 傳入,未經同意不擅改 `inputs`/`outputs` 契約。目錄沒有 `action.yml` 時可走**問答式從零建立**(收集名稱/輸入輸出/執行目標後產生 composite `action.yml` 並實作 steps,再接後續階段)。skill 各檔的「更新時間」於最終階段(funcs 完成後)**統一同步為同一時間戳**。
|
||||||
|
|
||||||
|
參數:`[--action-dir <action 根目錄>] [--manifest <action.yml 路徑>]`(根目錄預設目前工作目錄;manifest 自動尋找 `action.yml`/`action.yaml`)。
|
||||||
|
|
||||||
|
- **Claude Code / Antigravity**:`/jsc-code:action-composite`,或 `/jsc-code:action-composite --action-dir ~/work/my-action`
|
||||||
|
- **Codex**:`$action-composite`,或 `$action-composite --action-dir ~/work/my-action`,或用 `/skills` 選單
|
||||||
|
- **OpenCode**:描述需求(如「把這個 composite action 標準化,在 steps 最前面加一個會輸出 action 名稱/用途/更新時間的 step,最後跑 funcs 補文件並重建 README」)自動觸發
|
||||||
|
|
||||||
|
### `action-node`
|
||||||
|
|
||||||
|
把 Gitea/GitHub「Node(JavaScript)action」專案標準化,再串接文件化流程。node action 由 **runner 內建 Node 直接執行 `runs.main`**(不需 Docker、啟動比 docker action 快),但 **runner 不會自動 `npm install`**——這是與 docker/composite 最大的差異。五階段:(A) 找出 action 專案、讀 `action.yml`/`action.yaml` 的 `name`/`description`、判斷主程式語言(無 manifest 可**問答式從零建立**);(B) 主程式**非 Node 則保守改寫為 Node**(高風險,先以 AskUserQuestion 確認,保留對外行為),並把**主程式依賴鏈**的 `.js` 集中到 **`src/`**(工具設定檔與測試目錄不搬)、同步更新 `require`/`import` 路徑、`package.json` 與 `action.yml`;(C) 對齊 `runs` 為 node action(`using: node24` + `main`,`--node-version` 可覆寫、runner 太舊退 `node20`),**`outputs` 去除 `value`**(node 只需 `description`,值於執行時寫入 `$GITHUB_OUTPUT`)、**`inputs` 由 runner 自動注入 `INPUT_*`**(不像 composite 需手動映射),並在**主程式入口最前面**以 `console.log` 輸出 action 名稱/用途/更新時間(Asia/Taipei `yyyy/MM/dd HH:mm:ss`;node action 無 `entrypoint.sh`,橫幅改在 JS 輸出);(D) 相依處理——**零相依**則 `main` 直接指 `src/index.js`,**有相依**則以 [`@vercel/ncc`](https://github.com/vercel/ncc) 打包成 `dist/index.js`、`main` 改指 `dist/index.js` 並**把 `dist/` commit 進 repo**(確認 `.gitignore` 未忽略);(E) 對整個專案**完整執行 `/jsc-doc:funcs`**(function 文件、`src/` 主程式與 `action.yml` 註解、重建 README)。開發中需要新參數時依**參數來源優先序**處理:主程式優先取 runner 注入的 `GITHUB_*`/`GITEA_*` 執行期環境變數,既有 `inputs` 以 `process.env.INPUT_*`(或 `core.getInput`)取用,無法取得才經使用者同意**新增 `inputs`**;`secrets`/`vars` **一律視為不可用**,需要時宣告為 `inputs` 由呼叫端 workflow 以 `with:` 傳入,未經同意不擅改 `inputs`/`outputs` 契約。skill 各檔的「更新時間」於最終階段(funcs 完成後)**統一同步為同一時間戳**。
|
||||||
|
|
||||||
|
參數:`[--action-dir <action 根目錄>] [--node-version <node runtime>] [--main <主程式檔>]`(根目錄預設目前工作目錄;node 版本預設 `node24`;主程式自動判斷)。
|
||||||
|
|
||||||
|
- **Claude Code / Antigravity**:`/jsc-code:action-node`,或 `/jsc-code:action-node --action-dir ~/work/my-action --node-version node24`
|
||||||
|
- **Codex**:`$action-node`,或 `$action-node --action-dir ~/work/my-action`,或用 `/skills` 選單
|
||||||
|
- **OpenCode**:描述需求(如「把這個 action 主程式改成 node、主程式相關 js 收進 src/,對齊 action.yml 為 node action、在主程式最前面輸出 action 名稱/用途/更新時間,有相依就用 ncc 打包成 dist 並 commit,最後跑 funcs 補文件並重建 README」)自動觸發
|
||||||
|
|
||||||
|
### `image`
|
||||||
|
|
||||||
|
把專案既有的 `Dockerfile` **整理成固定六步流程**,再串接文件化流程。三階段:(A) 找出專案根目錄、定位目標 `Dockerfile`(找不到則詢問、**不臆造**;要產生全新 action 容器請改用 `action-docker`),讀現有指令、判斷語言/生態與既有 base image/建置流程;(B) 在**保留建置行為**前提下,把指令重整/歸位為**六步流程**(參數處理 → 安裝套件 → 複製檔案 → 執行程序 → 縮小映像檔 → 設定入口):可調參數集中於檔首 `ARG`、相依描述先 `COPY` 以利 layer 快取、**多階段建置**讓 runtime 改用較小基底(`*-slim`/`*-alpine`/`distroless` 等)只帶執行所需產物;`ENTRYPOINT`/`CMD`/`EXPOSE`/`ENV` 等對外契約不動,**無法保證等價的重整先以 AskUserQuestion 確認**(可選最小重排或只補註解);(C) 對整個專案**完整執行 `/jsc-doc:funcs`**(`Dockerfile` 等指令檔逐行註解、function 文件、重建 README)。
|
||||||
|
|
||||||
|
參數:`[--project-dir <專案根目錄>] [--dockerfile <Dockerfile 路徑>] [--yes]`(專案根目錄預設目前工作目錄;Dockerfile 自動定位、多個時詢問;`--yes` 略過一般確認,但「重整無法保證行為等價」與 funcs 的實作詢問仍會中斷)。
|
||||||
|
|
||||||
|
- **Claude Code / Antigravity**:`/jsc-code:image`,或 `/jsc-code:image --project-dir ~/work/my-app --dockerfile build/Dockerfile`
|
||||||
|
- **Codex**:`$image`,或 `$image --dockerfile docker/Dockerfile`,或用 `/skills` 選單
|
||||||
|
- **OpenCode**:描述需求(如「把這個專案的 Dockerfile 整理成參數處理→安裝套件→複製檔案→執行程序→縮小映像檔→設定入口六步、用多階段建置縮小映像,最後跑 funcs 補文件並重建 README」)自動觸發
|
||||||
|
|
||||||
|
### `target`
|
||||||
|
|
||||||
|
把**專案根目錄的 `TARGET.md`** 當每日待辦清單,並用**系統排程**(Linux/WSL/macOS 用 `crontab`、Windows 用 `schtasks`)在**每天 00:00** 自動跑完它。三種用法:**`--schedule on`** 建立或更新排程(同一專案只留一筆,以 `# jsc-code:target <專案路徑>` 標記比對,**絕不覆寫整份 crontab 或刪掉其他人的排程**;安裝後會檢查排程服務是否真的在跑,**WSL 預設不啟動 cron 會明確提醒**;log 刻意寫到 `~/.jsc/` 而非專案內,避免污染變更盤點)、**`--schedule off`** 只移除自己那一筆、**`--run`** 立即(或由排程)執行一次。`--run` 走六階段:**(A Git 同步)** 工作區有未提交變更就停止(不 stash/不 reset),`fetch` 後切到 `develop`,**遠端沒有 `develop` 就從遠端預設分支建立一條**;**(B 盤點)** 讀 `TARGET.md` 的 `- [ ]` 未勾選項目(含子項目從屬關係)依檔案順序排定,檔案不存在或全部完成則正常結束;**(C 逐項實作)** 一次做一項、做完就地把該行改成 `- [x]` 並補上 `(yyyy/MM/dd HH:mm:ss 完成)`,語意不明或驗證失敗者**不硬做**、保持未勾選並補 `> ⏭️ 待人工處理:<原因>`;**(D 分類提交)** 依 conventional commit 類型分組,每型一個 commit、範圍寫實際模組名;**(E push)** 推 `develop`(認證管理器 → token → 失敗停止);**(F 發 PR)** 透過 Gitea API 對**遠端預設分支**開 PR,**已有相同 `develop` → 預設分支的 open PR 就沿用不重開**(每天執行不會灌一堆 PR)。不帶參數時只回報現況(排程裝了沒、下次執行時間、剩幾項未完成)。排程是非互動環境,建立前會提醒**先在該專案預先授權**助理所需工具,但不代為加上略過權限的旗標。
|
||||||
|
|
||||||
|
參數:`[--schedule on|off] [--run] [--project-dir <專案根目錄>] [--cli <claude|codex|agy|opencode|copilot>] [--base <PR 目標分支>] [--no-pr] [--yes]`(專案根目錄預設目前工作目錄;`--cli` 預設為目前執行的助理,判斷不出來才問;`--base` 省略時自動取遠端預設分支;執行時間固定每天 00:00)。
|
||||||
|
|
||||||
|
- **Claude Code / Antigravity**:`/jsc-code:target --schedule on`、`/jsc-code:target --schedule off`、`/jsc-code:target --run --yes`、`/jsc-code:target --schedule on --run --project-dir ~/work/app`
|
||||||
|
- **Codex**:`$target --schedule on`,或 `$target --run --yes`,或用 `/skills` 選單
|
||||||
|
- **OpenCode**:描述需求(如「幫我把這個專案的 TARGET.md 排成每天 00:00 自動執行,做完分類提交、push develop 並對預設分支發 PR」)自動觸發
|
||||||
|
|
||||||
<!-- JSC-SKILLS:END -->
|
<!-- JSC-SKILLS:END -->
|
||||||
|
|
||||||
@@ -175,15 +290,16 @@ rm -rf ~/.config/opencode/skills/hello
|
|||||||
|
|
||||||
## 新增一個 skill
|
## 新增一個 skill
|
||||||
|
|
||||||
1. 複製範本:`cp -r skills/hello skills/<your-skill-name>`
|
1. 複製既有 skill 作範本:`cp -r skills/issues skills/<your-skill-name>`
|
||||||
2. 編輯 `skills/<your-skill-name>/SKILL.md` 的 frontmatter:
|
2. 編輯 `skills/<your-skill-name>/SKILL.md` 的 frontmatter:
|
||||||
- `name`:小寫、數字、連字號(`-`),最長 64 字元。**這就是 Claude Code / Antigravity 的 `/jsc:<name>`**。
|
- `name`:小寫、數字、連字號(`-`),最長 64 字元。**這就是 Claude Code / Antigravity 的 `/jsc-code:<name>`**。
|
||||||
- `description`:第三人稱,寫清楚「何時用、何時不用」與觸發關鍵字 — 這是各助理自動載入的唯一依據。
|
- `description`:第三人稱,寫清楚「何時用、何時不用」與觸發關鍵字 — 這是各助理自動載入的唯一依據。
|
||||||
3. 在內文寫下 skill 的具體步驟。
|
3. 在內文寫下 skill 的具體步驟。
|
||||||
4. 手動把這個 skill 補進上方「Skills 目錄」區塊。
|
4. 手動把這個 skill 補進上方「Skills 目錄」區塊。
|
||||||
5. **bump 版本並 push**:四家都以 git 內容/版本判斷更新,請把 `.claude-plugin/plugin.json`、`.codex-plugin/plugin.json`、`plugin.json` 三個 manifest 的 `version` 一起 bump,commit 後 push 到 gitea。
|
5. **bump 版本並 push**:各助理都以 git 內容/版本判斷更新,請把 `.claude-plugin/plugin.json`、`.codex-plugin/plugin.json`、`plugin.json` 三個 manifest 的 `version` 一起 bump,commit 後 push 到 gitea。
|
||||||
6. 讓各助理更新:
|
6. 讓各助理更新:
|
||||||
- Claude:`claude plugin update jsc@jsc-plugins`
|
- Claude:`claude plugin update jsc-code@code`
|
||||||
- Codex:`codex plugin marketplace upgrade jsc-plugins`
|
- Codex:`codex plugin marketplace upgrade code`
|
||||||
- Antigravity:`git -C ~/jsc-plugin pull && agy plugin uninstall jsc && agy plugin install ~/jsc-plugin`
|
- Antigravity:`git -C ~/plugins/code pull && agy plugin uninstall jsc-code && agy plugin install ~/plugins/code`
|
||||||
- OpenCode:`git pull` 後重新複製 `skills/`
|
- OpenCode:`git pull` 後重新複製 `skills/`
|
||||||
|
- Copilot:`copilot plugin marketplace update code && copilot plugin update jsc-code@code`
|
||||||
|
|||||||
+4
-4
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "jsc",
|
"name": "jsc-code",
|
||||||
"version": "0.1.0",
|
"version": "0.0.3",
|
||||||
"description": "JSC 跨 AI 助理共用 plugin 模板。所有 skills 以 SKILL.md 為共通標準;於 Antigravity 以 /jsc: 前綴呼叫。",
|
"description": "JSC 程式碼工作流 plugin,提供 Gitea AI review findings 修復/PR 流程、Gitea 議題 TODO 彙整與逐項實作、C# / .NET NuGet 套件更新、Gitea 專案批次同步,以及 action / Dockerfile 標準化流程;於 Antigravity 以 /jsc-code: 前綴呼叫。",
|
||||||
"skills": "./skills/"
|
"skills": "./skills/"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,205 @@
|
|||||||
|
---
|
||||||
|
name: action-composite
|
||||||
|
description: 將 Gitea/GitHub「composite action」專案標準化(目錄沒有 action manifest 時可問答式從零建立)並串接文件化流程:(1) 確認 action 為 composite(`runs.using: composite`),非 composite 則保守確認後對齊;(2) 在 `runs.steps` 最前面注入啟動橫幅 step,輸出 action 名稱/用途/更新時間(Asia/Taipei `yyyy/MM/dd HH:mm:ss`),並於 `action.yml` 開頭補用途/更新時間註解區塊;(3) 開發中需要新參數時優先取用 `${{ gitea.* }}`/`${{ github.* }}` context,無法取得才詢問使用者是否新增 `inputs`(`secrets`/`vars` context 在 composite action 內一律視為不可用,需要時宣告為 `inputs` 由呼叫端 workflow 傳入);(4) 最後完整執行 `/jsc-doc:funcs` 處理流程(function 文件、指令檔逐行註解、重建 README)。當使用者說整理 composite action、從零建立/產生一個 composite action、把 action 標準化為 composite、讓 composite action 啟動時印名稱/用途/更新時間、處理 composite action 參數來源、對 composite action 補文件,或提到 action-composite 時觸發。不適用於:Docker 容器 action(用 action-docker)、或不需 action 化/文件化的一般 repo。
|
||||||
|
argument-hint: "[--action-dir <action 根目錄>] [--manifest <action.yml 路徑>]"
|
||||||
|
---
|
||||||
|
|
||||||
|
# action-composite — composite action 標準化+文件化
|
||||||
|
|
||||||
|
四階段 skill:先做**前置設定與偵測**(找出 action 專案、讀取名稱/用途、判斷是否為 composite),再**確認/對齊為 composite action**,接著在 `runs.steps` 最前面**注入會輸出 action 名稱/用途/更新時間的啟動橫幅 step**,最後**完整執行 `/jsc-doc:funcs` 處理流程**替整個專案補文件並重建 README。各階段開發中需要新參數時,一律套用下方「**參數來源優先序**」規則。目錄沒有 action manifest 時,先走 A1a 問答式「**從零建立**」分支產生 composite `action.yml`,再進入後續階段。
|
||||||
|
|
||||||
|
| 階段 | 動作 |
|
||||||
|
| --- | --- |
|
||||||
|
| A. 前置設定與偵測 | 決定 action 根目錄 → 讀 `action.yml`/`action.yaml` 的 `name`/`description`/`runs` → 判斷是否為 composite(無 manifest 可走 A1a 從零建立) |
|
||||||
|
| B. 對齊為 composite | 已是 composite 則保留既有 `steps`;非 composite 則**保守確認後對齊**(高風險,先確認),整理被引用的腳本路徑 |
|
||||||
|
| C. 注入啟動橫幅 step | 在 `runs.steps` 最前面插入一個 shell step,輸出 action **名稱/用途/更新時間**;並於 `action.yml` 開頭補用途/更新時間註解區塊 |
|
||||||
|
| D. 串接 funcs | 對整個 action 專案完整執行 `/jsc-doc:funcs` 流程(function 文件、指令檔逐行註解、重建 README) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 共用規範(shared plugin,必要前置)
|
||||||
|
|
||||||
|
執行本 skill 前,先以 Skill 工具載入下列共用規範並全程遵守;**任一載入不到(shared plugin 未安裝)時,先詢問使用者是否安裝 shared plugin(`https://gitea.jsc.idv.tw/plugins/shared.git`),使用者不安裝則直接中斷本 skill**,不得只憑下方一行摘要繼續執行:
|
||||||
|
|
||||||
|
- `/jsc-shared:spec-output`:繁體中文(台灣用語)、UTF-8(不含 BOM)無亂碼。
|
||||||
|
- `/jsc-shared:spec-execution`:自動執行原則(必要決策才中斷)、不臆測/需人工確認、不擴及無關檔案。
|
||||||
|
- `/jsc-shared:spec-git-safety`:不破壞既有工作(絕不 `reset --hard`/`clean`)、`git mv` 保留歷史。
|
||||||
|
- `/jsc-shared:spec-action-params`:action 參數來源優先序(context → 經同意新增 `inputs`)、`secrets`/`vars` 一律視為不可用。
|
||||||
|
- `/jsc-shared:spec-time-log`:更新時間 Asia/Taipei `yyyy/MM/dd HH:mm:ss`、完成後統一同步時間戳。
|
||||||
|
- `/jsc-shared:spec-doc-funcs-handoff`:最終階段完整執行 `/jsc-doc:funcs` 的標準流程。
|
||||||
|
|
||||||
|
本 skill 特有補充:
|
||||||
|
|
||||||
|
- **一定會中斷詢問的點**:階段 B 主 action「非 composite 需對齊」時(破壞性,須先確認),以及階段 D 由 `/jsc-doc:funcs` 自身的「如何實作」詢問。
|
||||||
|
- **保留行為**:對齊 composite 與注入橫幅 step 只「補強」既有流程,不得擅自改變既有 `steps` 的執行順序、輸入(`inputs`)/輸出(`outputs`)契約或副作用;任何無法可靠等價推論的改動一律不做,並以註解或回報標註「需人工確認」。新增 `input` 僅限依 `/jsc-shared:spec-action-params` 經使用者同意後為之。
|
||||||
|
- **本 skill 只動**:action 專案根目錄內的 `action.yml`/`action.yaml`、其 `steps` 直接引用的內嵌腳本(如 `*.sh`/`*.ps1`),以及階段 D 由 funcs 流程處理的目標。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 參數來源優先序(開發中需要新參數時)
|
||||||
|
|
||||||
|
從零建立(A1a)、對齊 composite(階段 B)、注入橫幅 step(階段 C)或補強被引用腳本的過程中,若需要新的參數值,一律依 `/jsc-shared:spec-action-params` 的優先序處理:composite 的 `runs.steps` 內優先取 `${{ gitea.* }}`/`${{ github.* }}` context(建議寫 `github.*` 以相容兩邊;`run` 腳本內可改讀 `$GITHUB_*` 環境變數),取不到才以 `AskUserQuestion` 經使用者同意新增 `inputs`;`secrets`/`vars` 一律視為不可用,需要時宣告為 `input` 由呼叫端 workflow 傳入(範例見該 spec)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 參數
|
||||||
|
|
||||||
|
格式:`[--action-dir <action 根目錄>] [--manifest <action.yml 路徑>]`
|
||||||
|
|
||||||
|
- `--action-dir <action 根目錄>`:action 專案根目錄。**省略時預設目前工作目錄**(須含 `action.yml`/`action.yaml`,否則依 A1 詢問)。
|
||||||
|
- `--manifest <action.yml 路徑>`:指定 action manifest 檔(相對 action 根目錄)。省略時依 A1 自動尋找 `action.yml`/`action.yaml`。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 A:前置設定與偵測
|
||||||
|
|
||||||
|
### A1. 決定 action 根目錄與 manifest
|
||||||
|
|
||||||
|
- 帶 `--action-dir` → 採用(展開 `~`);省略 → 用目前工作目錄。
|
||||||
|
- manifest:帶 `--manifest` → 採用;否則於根目錄找 `action.yml`,再退而 `action.yaml`。
|
||||||
|
- **找不到** action manifest → **不臆測**、不逕自動工;以 `AskUserQuestion` 詢問使用者要「**從零建立**新的 composite action」還是「提供正確的 action 路徑」:選「從零建立」→ 進入 A1a;選「提供路徑」→ 依新路徑重跑 A1。
|
||||||
|
|
||||||
|
### A1a. 從零建立 composite action(問答式)
|
||||||
|
|
||||||
|
依序以問答收集需求,再產生 manifest:
|
||||||
|
|
||||||
|
1. **action 名稱**:用於 `action.yml` 的 `name`。
|
||||||
|
2. **輸入與輸出參數**:逐一收集 `inputs`/`outputs` 的名稱與 `description`(description 盡量繁體中文、無亂碼)、`required`/`default`;沒有可留空。
|
||||||
|
3. **執行目標**:詢問此 action 要達成什麼,整理濃縮成一句話作為 `action.yml` 的 `description`(盡量繁體中文、無亂碼)。
|
||||||
|
|
||||||
|
收集完成後,於 action 根目錄產生 `action.yml`(`runs.using: composite`,含收集到的 `name`/`description`/`inputs`/`outputs`),並依執行目標以 composite steps 實作(開發中需要新參數時套用「參數來源優先序」);完成後接續 A2 往後流程(A3 必為 composite,階段 B 走「已是 composite」分支)。
|
||||||
|
|
||||||
|
### A2. 讀取 action 名稱與用途
|
||||||
|
|
||||||
|
從 action manifest 讀取:
|
||||||
|
|
||||||
|
- `name`:action 名稱(供啟動橫幅與 README 使用)。
|
||||||
|
- `description`:action 用途。
|
||||||
|
- `runs`:目前的執行設定(`using`、`steps`、`main`、`image`、`entrypoint` 等)。
|
||||||
|
- `inputs`/`outputs`:對外契約(後續不得破壞)。
|
||||||
|
|
||||||
|
若 `name`/`description` 缺漏,回報缺漏並**詢問一次**;使用者跳過或無法提供時,於後續輸出以「(未提供)」標示續行,**不編造**。
|
||||||
|
|
||||||
|
### A3. 判斷是否為 composite
|
||||||
|
|
||||||
|
依 `runs.using` 判定:
|
||||||
|
|
||||||
|
- `composite` → 即為目標型態,記下既有 `runs.steps`,直接進入階段 B 的「已是 composite」分支。
|
||||||
|
- `node*`(JS action)/`docker`(Docker 容器 action)/其他 → 視為**非 composite**。
|
||||||
|
|
||||||
|
輸出偵測結果(action 名稱、用途、`runs.using`、是否為 composite、既有 step 數量),再進入階段 B。
|
||||||
|
|
||||||
|
> 若偵測為 **Docker 容器 action**,此處**僅輸出偵測結果**並提醒可改用 `/jsc-code:action-docker`,**不詢問**;是否對齊/維持原樣/改用 action-docker 的決策,統一由階段 B2 的一次 `AskUserQuestion` 收斂。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 B:確認/對齊為 composite action
|
||||||
|
|
||||||
|
### B1. 已是 composite
|
||||||
|
|
||||||
|
- 確認 `runs.using: composite` 與既有 `runs.steps`,**不更動既有 steps 的順序與邏輯**,直接進入階段 C。
|
||||||
|
- 順手檢查 step 的必要欄位:`run` step 缺 `shell` 屬**原檔錯誤**(GitHub/Gitea 都會拒跑),**允許補上 `shell: bash`** 並在回報中列出;其他疑慮(如 `uses` step 的引用是否存在)以回報標註、不擅改。
|
||||||
|
|
||||||
|
### B2. 非 composite(需對齊)
|
||||||
|
|
||||||
|
這是**破壞性高風險決策**:先以 `AskUserQuestion` 向使用者確認,選項至少含「對齊為 composite」「維持原樣只做文件化(略過對齊)」「改用 action-docker」「其他」。經確認「對齊為 composite」後才改寫:
|
||||||
|
|
||||||
|
- 將 `runs` 保守對齊為 composite,把原執行入口轉為 composite step:
|
||||||
|
- 原 JS action(`runs.using: node*`,`runs.main: <x>.js`)→ 轉為一個 `run` step,於 step 內以 `node <x>.js` 執行(`shell: bash`)。composite step **不會自動注入 `INPUT_*` 環境變數、也不會自動轉接 outputs**,必須手動補齊兩段映射(見下方範例):
|
||||||
|
- **inputs 映射**:step 加 `env:`,逐一宣告 `INPUT_<大寫名稱>: ${{ inputs.<name> }}`——主程式的 `getInput()`/`process.env.INPUT_*` 才拿得到值。
|
||||||
|
- **outputs 轉接**:step 設 `id`,action 層 `outputs` 逐一宣告 `value: ${{ steps.<id>.outputs.<name> }}`(主程式寫入 `$GITHUB_OUTPUT` 的值由此轉出)。
|
||||||
|
- **硬條件**:無法完成上述兩項映射(inputs/outputs 無法逐一對應)時**不對齊**,以 `# 需人工確認` 標註並回報。
|
||||||
|
- 原 Docker action(`runs.using: docker`)→ Docker 行為通常無法可靠等價地塞進 composite;**不臆測改寫**,以回報+`# 需人工確認` 標註,並建議改用 `/jsc-code:action-docker`。
|
||||||
|
- 任何無法可靠等價對齊處,**不臆測**:以 `# 需人工確認:...` 標註並回報,保留原檔行為。
|
||||||
|
- 對齊過程需要新的參數值(如 token、repo 資訊、外部設定)時,依「參數來源優先序」處理,不逕自新增 `inputs`。
|
||||||
|
|
||||||
|
對齊後(含 inputs 映射與 outputs 轉接)形如:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
inputs:
|
||||||
|
foo:
|
||||||
|
description: <沿用原 input 宣告>
|
||||||
|
outputs:
|
||||||
|
bar:
|
||||||
|
description: <沿用原 output 宣告>
|
||||||
|
value: ${{ steps.main.outputs.bar }} # outputs 轉接:由 step outputs 轉出
|
||||||
|
|
||||||
|
runs:
|
||||||
|
using: composite
|
||||||
|
steps:
|
||||||
|
# (階段 C 會在此處最前面插入啟動橫幅 step)
|
||||||
|
- name: <原執行入口轉成的 step>
|
||||||
|
id: main
|
||||||
|
shell: bash
|
||||||
|
env:
|
||||||
|
INPUT_FOO: ${{ inputs.foo }} # inputs 映射:composite 不會自動注入 INPUT_*
|
||||||
|
run: node ./index.js
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 C:注入啟動橫幅 step(輸出名稱/用途/更新時間)
|
||||||
|
|
||||||
|
在 `runs.steps` **最前面**插入(或更新)一個輸出橫幅的 step,讓 composite action 一啟動就**輸出 action 名稱、用途、更新時間**;並於 `action.yml` 開頭補用途/更新時間註解區塊。
|
||||||
|
|
||||||
|
- **更新時間**依 `/jsc-shared:spec-time-log`(Asia/Taipei、固定 `yyyy/MM/dd HH:mm:ss`、寫成檔內固定字串)。本階段先寫入暫定時間戳,**階段 D 完成後會統一同步各處時間戳**(見階段 D)。
|
||||||
|
- 名稱/用途取自階段 A2 的 `action.yml`(缺漏時以「(未提供)」標示)。
|
||||||
|
- 橫幅 step 須有可辨識的 `name`(如 `顯示 action 資訊`)與 `shell: bash`;其後緊接既有/對齊後的 steps,**不更動既有 steps**。
|
||||||
|
- 若已存在本 skill 先前插入的橫幅 step(依 `name` 辨識),則**更新**其內容與更新時間,不重複插入。
|
||||||
|
|
||||||
|
範例(既有 steps 接在橫幅 step 之後):
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: <action name>
|
||||||
|
description: <action description>
|
||||||
|
|
||||||
|
runs:
|
||||||
|
using: composite
|
||||||
|
steps:
|
||||||
|
# 啟動橫幅:輸出名稱/用途/更新時間(此 step 由 action-composite 產生)
|
||||||
|
- name: 顯示 action 資訊
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
echo "================================================"
|
||||||
|
echo "Action : <action name>"
|
||||||
|
echo "用途 : <action description>"
|
||||||
|
echo "更新時間: 2026/06/30 18:30:05"
|
||||||
|
echo "================================================"
|
||||||
|
# === 以下為既有/對齊後的 steps(保持原順序與邏輯)===
|
||||||
|
- name: <既有 step>
|
||||||
|
shell: bash
|
||||||
|
run: node ./index.js
|
||||||
|
```
|
||||||
|
|
||||||
|
- `action.yml` 開頭的「用途/更新時間」註解區塊與每行註解,最終會在階段 D 由 `/jsc-doc:funcs` 的指令檔流程統一補齊/覆寫為標準格式(用途與更新日期同一註解區塊、逐行註解);本階段先確保**執行期橫幅輸出**正確即可。
|
||||||
|
- 自我檢查:插入橫幅 step 後 YAML 仍可解析(縮排、`steps` 為 list、每個 `run` step 都有 `shell`),且 `inputs`/`outputs` 未被更動。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 D:完整執行 /jsc-doc:funcs 處理流程
|
||||||
|
|
||||||
|
標準化完成後,以階段 A1 的 action 根目錄為目標,依 `/jsc-shared:spec-doc-funcs-handoff` 對**整個 action 專案**完整執行 `/jsc-doc:funcs` 流程(前置可用性檢查、完整流程、由使用者裁示實作方式、重建 README)。完成後依該 spec **統一時間戳**:回頭同步橫幅 step 內文、`action.yml` 開頭註解區塊與 README 的更新時間,確保各處一致。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 總結
|
||||||
|
|
||||||
|
各階段執行後輸出:
|
||||||
|
|
||||||
|
- **階段 A**:action 根目錄、manifest 路徑、action 名稱/用途、`runs.using`、是否為 composite、既有 step 數量;若走 A1a 從零建立,列出問答收集結果(名稱/輸入輸出/目標)。
|
||||||
|
- **階段 B**:是否對齊為 composite(及對齊摘要與「需人工確認」清單),或維持原樣的理由;依「參數來源優先序」新增的 `inputs` 清單與呼叫端傳入寫法(若有)。
|
||||||
|
- **階段 C**:橫幅 step 的輸出內容(名稱/用途/更新時間)與插入位置,並確認既有 steps、`inputs`/`outputs` 未被破壞。
|
||||||
|
- **階段 D**:funcs 流程的處理結果(文件化的 function 與指令檔、重建的 README)。
|
||||||
|
- 列出本次新增/變更的檔案與其相對路徑,並提醒使用者於提交前確認 `action.yml` 可正常解析、composite action 能正確啟動並輸出橫幅。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 呼叫方式
|
||||||
|
|
||||||
|
格式:`[--action-dir <action 根目錄>] [--manifest <action.yml 路徑>]` — 全部可省略(根目錄預設目前工作目錄;manifest 自動尋找)。
|
||||||
|
|
||||||
|
| 助理 | 呼叫 |
|
||||||
|
| --- | --- |
|
||||||
|
| Claude Code / Antigravity | `/jsc-code:action-composite`,或 `/jsc-code:action-composite --action-dir ~/work/my-action` |
|
||||||
|
| Codex | `$action-composite`,或 `$action-composite --action-dir ~/work/my-action`,或用 `/skills` 選單 |
|
||||||
|
| OpenCode | 描述需求(如「把這個 composite action 標準化,在 steps 最前面加一個會輸出 action 名稱/用途/更新時間的 step,最後跑 funcs 補文件並重建 README」)自動觸發 |
|
||||||
@@ -0,0 +1,266 @@
|
|||||||
|
---
|
||||||
|
name: action-docker
|
||||||
|
description: 將 Gitea/GitHub「Docker 容器 action」專案標準化為 Node 主程式+容器化(目錄沒有 action manifest 時可問答式從零建立),並串接文件化流程:(1) 檢查 action 主程式是否為 Node,否則保守改寫為 Node,且主程式及其依賴鏈的 `.js` 檔集中到 `src/` 資料夾(工具設定檔與測試目錄不搬);(2) 產生 `entrypoint.sh`,啟動前先輸出 action 名稱/用途/更新時間,再執行 node 主程式;(3) 產生使用最新 LTS node 版本的 `Dockerfile`;(4) 開發中需要新參數時優先取用 runner 注入的 `GITHUB_*`(Gitea 亦有 `GITEA_*`)執行期環境變數(即 `gitea.*`/`github.*` context 的同源資訊),無法取得才詢問使用者是否新增 `inputs`(`secrets`/`vars` context 在 docker action 內一律視為不可用,需要時宣告為 `inputs` 由呼叫端 workflow 傳入);(5) 最後完整執行 `/jsc-doc:funcs` 處理流程(function 文件、指令檔逐行註解、重建 README)。當使用者說把 action 改成 docker/node、從零建立/產生一個 docker action、容器化 action、action 主程式 node 化、把 js 收進 src、產 entrypoint.sh/Dockerfile 給 action、處理 docker action 參數來源,或提到 action-docker 時觸發。不適用於:composite action(用 action-composite)、純前端打包、或不需容器化的一般 repo。
|
||||||
|
argument-hint: "[--action-dir <action 根目錄>] [--node-version <node tag>] [--main <主程式檔>]"
|
||||||
|
---
|
||||||
|
|
||||||
|
# action-docker — action 容器化(Node 主程式)+文件化
|
||||||
|
|
||||||
|
五階段 skill:先做**前置設定與偵測**(找出 action 專案、讀取名稱/用途、判斷主程式語言),再把**主程式 Node 化並將主程式依賴鏈的 `.js` 收進 `src/`**,接著產生**啟動前先輸出 action 名稱/用途/更新時間的 `entrypoint.sh`**,然後產生**使用最新 LTS node 版本的 `Dockerfile`**(並對齊 `action.yml` 的 docker 設定),最後**完整執行 `/jsc-doc:funcs` 處理流程**替整個專案補文件並重建 README。產出的 docker action 需在**具 Docker 能力的 runner(docker 模式)**上執行。各階段開發中需要新參數時,一律套用下方「**參數來源優先序**」規則。目錄沒有 action manifest 時,先走 A1a 問答式「**從零建立**」分支產生 `action.yml` 與 Node 主程式骨架,再進入後續階段。
|
||||||
|
|
||||||
|
| 階段 | 動作 |
|
||||||
|
| --- | --- |
|
||||||
|
| A. 前置設定與偵測 | 決定 action 根目錄 → 讀 `action.yml`/`action.yaml` 的 `name`/`description` → 判斷目前主程式與語言(無 manifest 可走 A1a 從零建立) |
|
||||||
|
| B. 主程式 Node 化 | 主程式非 Node 則**保守改寫**為 Node(高風險,先確認)→ 主程式依賴鏈的 `.js` 集中到 `src/`,更新所有引用、`package.json`、`action.yml` |
|
||||||
|
| C. entrypoint.sh | 產生 `entrypoint.sh`:先輸出 action **名稱/用途/更新時間**,再 `exec` node 主程式 |
|
||||||
|
| D. Dockerfile | 依六步流程(參數處理 → 安裝套件 → 複製檔案 → 執行程序 → 縮小映像檔 → 設定入口)產生使用**最新 LTS node 版本**的 `Dockerfile`,多階段建置縮小映像、`ENTRYPOINT` 指向 `entrypoint.sh` |
|
||||||
|
| E. 串接 funcs | 對整個 action 專案完整執行 `/jsc-doc:funcs` 流程(function 文件、指令檔逐行註解、重建 README) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 共用規範(shared plugin,必要前置)
|
||||||
|
|
||||||
|
執行本 skill 前,先以 Skill 工具載入下列共用規範並全程遵守;**任一載入不到(shared plugin 未安裝)時,先詢問使用者是否安裝 shared plugin(`https://gitea.jsc.idv.tw/plugins/shared.git`),使用者不安裝則直接中斷本 skill**,不得只憑下方一行摘要繼續執行:
|
||||||
|
|
||||||
|
- `/jsc-shared:spec-output`:繁體中文(台灣用語)、UTF-8(不含 BOM)無亂碼。
|
||||||
|
- `/jsc-shared:spec-execution`:自動執行原則(必要決策才中斷)、不臆測/需人工確認、不擴及無關檔案。
|
||||||
|
- `/jsc-shared:spec-git-safety`:不破壞既有工作(絕不 `reset --hard`/`clean`)、`git mv` 保留歷史。
|
||||||
|
- `/jsc-shared:spec-action-params`:action 參數來源優先序(環境變數 → 經同意新增 `inputs`)、`secrets`/`vars` 一律視為不可用。
|
||||||
|
- `/jsc-shared:spec-time-log`:更新時間 Asia/Taipei `yyyy/MM/dd HH:mm:ss`、完成後統一同步時間戳。
|
||||||
|
- `/jsc-shared:spec-dockerfile`:Dockerfile 六步流程、多階段建置、固定版號、自我檢查。
|
||||||
|
- `/jsc-shared:spec-doc-funcs-handoff`:最終階段完整執行 `/jsc-doc:funcs` 的標準流程。
|
||||||
|
|
||||||
|
本 skill 特有補充:
|
||||||
|
|
||||||
|
- **一定會中斷詢問的點**:階段 B 主程式「非 Node 需改寫」時(破壞性,須先確認),以及階段 E 由 `/jsc-doc:funcs` 自身的「如何實作」詢問。
|
||||||
|
- **保留行為**:Node 化只「翻譯」既有邏輯,不得擅自改變對外行為、輸入輸出契約或副作用;任何無法可靠等價推論的改動一律不做,並以註解或回報標註「需人工確認」。新增 `input` 僅限依 `/jsc-shared:spec-action-params` 經使用者同意後為之。
|
||||||
|
- **本 skill 只動**:action 專案根目錄內的主程式、主程式依賴鏈的 `.js`(搬移到 `src/`)、`package.json`、`action.yml`/`action.yaml`、`entrypoint.sh`、`Dockerfile`、`.dockerignore`,以及階段 E 由 funcs 流程處理的目標。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 參數來源優先序(開發中需要新參數時)
|
||||||
|
|
||||||
|
從零建立(A1a)、主程式 Node 化(階段 B)、產生 `entrypoint.sh`(階段 C)或產生 `Dockerfile`(階段 D)的過程中,若需要新的參數值,一律依 `/jsc-shared:spec-action-params` 的優先序處理:Docker 容器 action 優先取 runner 注入的執行期環境變數(Node 主程式讀 `process.env.GITHUB_*`、`entrypoint.sh` 讀 `$GITHUB_*`;Gitea 亦提供 `GITEA_*` 同義變數,建議讀 `GITHUB_*` 以相容兩邊),取不到才以 `AskUserQuestion` 經使用者同意新增 `inputs`(容器內以 `INPUT_<大寫名稱>` 取用);`secrets`/`vars` 一律視為不可用,需要時宣告為 `input` 由呼叫端 workflow 傳入(範例見該 spec)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 參數
|
||||||
|
|
||||||
|
格式:`[--action-dir <action 根目錄>] [--node-version <node tag>] [--main <主程式檔>]`
|
||||||
|
|
||||||
|
- `--action-dir <action 根目錄>`:action 專案根目錄。**省略時預設目前工作目錄**(須含 `action.yml`/`action.yaml`,否則依 A1 詢問)。
|
||||||
|
- `--node-version <node tag>`:`Dockerfile` 的 node base image tag(如 `22`、`22-alpine`、`lts`)。**省略時預設使用當前最新 LTS major**(如 `node:22`,見階段 D)。tag 已是 `-alpine`/`-slim` 變體時,build 與 runtime **直接沿用同一 tag**、不再另組 `-slim`。
|
||||||
|
- `--main <主程式檔>`:指定主程式入口檔(相對 action 根目錄)。省略時依 A3 自動判斷。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 A:前置設定與偵測
|
||||||
|
|
||||||
|
### A1. 決定 action 根目錄
|
||||||
|
|
||||||
|
- 帶 `--action-dir` → 採用(展開 `~`)。
|
||||||
|
- 省略 → 用目前工作目錄。
|
||||||
|
- 根目錄須存在 `action.yml` 或 `action.yaml`(action manifest)。**找不到** action manifest → **不臆測**、不逕自動工;以 `AskUserQuestion` 詢問使用者要「**從零建立**新的 Docker 容器 action」還是「提供正確的 action 路徑」:選「從零建立」→ 進入 A1a;選「提供路徑」→ 依新路徑重跑 A1。
|
||||||
|
|
||||||
|
### A1a. 從零建立 Docker 容器 action(問答式)
|
||||||
|
|
||||||
|
依序以問答收集需求,再產生 manifest 與主程式骨架:
|
||||||
|
|
||||||
|
1. **action 名稱**:用於 `action.yml` 的 `name`。
|
||||||
|
2. **輸入與輸出參數**:逐一收集 `inputs`/`outputs` 的名稱與 `description`(description 盡量繁體中文、無亂碼)、`required`/`default`;沒有可留空。
|
||||||
|
3. **執行目標**:詢問此 action 要達成什麼,整理濃縮成一句話作為 `action.yml` 的 `description`(盡量繁體中文、無亂碼)。
|
||||||
|
|
||||||
|
收集完成後,於 action 根目錄產生:`action.yml`(`runs.using: docker`、`image: Dockerfile`,含收集到的 `name`/`description`/`inputs`/`outputs`)與 `src/index.js` 主程式(依執行目標以 Node 實作,輸入以 `process.env.INPUT_<NAME>` 讀取,開發中需要新參數時套用「參數來源優先序」);完成後接續 A2 往後流程(A3 判定為 Node,階段 B 走「已是 Node」分支,階段 C/D 照常產生 `entrypoint.sh` 與 `Dockerfile`)。
|
||||||
|
|
||||||
|
### A2. 讀取 action 名稱與用途
|
||||||
|
|
||||||
|
從 action manifest 讀取:
|
||||||
|
|
||||||
|
- `name`:action 名稱(供 `entrypoint.sh` 輸出與 README 使用)。
|
||||||
|
- `description`:action 用途。
|
||||||
|
- `runs`:目前的執行設定(`using`、`main`、`image`、`entrypoint` 等)。
|
||||||
|
|
||||||
|
若 `name`/`description` 缺漏,回報並請使用者補;無法取得時於後續輸出以「(未提供)」保守標示,**不編造**。
|
||||||
|
|
||||||
|
### A3. 判斷目前主程式與語言
|
||||||
|
|
||||||
|
依序判斷主程式入口(取第一個成立者):
|
||||||
|
|
||||||
|
1. 帶 `--main <主程式檔>` → 直接採用。
|
||||||
|
2. `action.yml` 為 JS action(`runs.using: node*`)→ 取 `runs.main`。
|
||||||
|
3. `action.yml` 為 docker action(`runs.using: docker`)→ 看 `runs.entrypoint`/`Dockerfile` 的 `ENTRYPOINT`/`CMD` 推主程式。
|
||||||
|
4. 以上皆無 → 依專案檔與副檔名分布推斷(`package.json` 的 `main`/`bin`、`index.js`、`*.sh`、`*.py` 等)。
|
||||||
|
|
||||||
|
判定**主程式是否為 Node**:入口為 `.js`/`.mjs`/`.cjs` 且由 `node` 執行即視為 Node;入口為 shell/python/其他則視為非 Node。輸出偵測結果(action 名稱、用途、主程式檔、判定語言、是否為 Node),再進入階段 B。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 B:主程式 Node 化,並將主程式依賴鏈的 `.js` 收進 `src/`
|
||||||
|
|
||||||
|
### B1. 主程式 Node 化
|
||||||
|
|
||||||
|
- **已是 Node** → 確認入口檔,不改寫邏輯,直接進 B2。
|
||||||
|
- **非 Node(shell/python/其他)** → 這是**破壞性高風險決策**:先以 `AskUserQuestion` 向使用者確認是否改寫為 Node,選項至少含「改寫為 Node」「維持原樣只做容器化(略過改寫)」「其他」。經確認後才改寫:
|
||||||
|
- 逐段把原主程式邏輯**保守翻譯**為 Node(建議 `index.js`);保留對外行為、輸入(環境變數/`INPUT_*`/args)與輸出(stdout/exit code/檔案副作用)契約。
|
||||||
|
- 外部指令呼叫以 `child_process`(`execFileSync`/`spawnSync`)對應;檔案操作以 `fs`;環境變數以 `process.env`。
|
||||||
|
- 任何無法可靠等價翻譯處,**不臆測**:以 `// 需人工確認:...` 標註並回報。
|
||||||
|
- 改寫完成後,原非 Node 主程式於 B2 一併處理(移除或保留由使用者裁示;預設保留並在 README/回報標註已由 Node 取代)。
|
||||||
|
|
||||||
|
### B2. 主程式依賴鏈的 `.js` 集中到 `src/`
|
||||||
|
|
||||||
|
- 在 action 根目錄建立 `src/`(若不存在)。
|
||||||
|
- 將**主程式入口及其 `require`/`import` 依賴鏈**的 `.js`/`.mjs`/`.cjs`(排除 `node_modules`/`.git`/`.docs`/`bin`/`obj`/第三方依賴)**移入 `src/`**,優先 `git mv` 保留歷史。主程式入口統一為 `src/index.js`(或 `src/<main>.js`)。
|
||||||
|
- **明文排除、不搬**:外部工具依慣例路徑尋找的檔案——`*.config.js`(`eslint.config.js`/`jest.config.js`/`webpack.config.js` 等)、`.*rc.js`、husky/commitlint 等工具設定,以及 `test/`/`tests/`/`scripts/` 目錄;搬走會弄壞 lint/test/build 流程。
|
||||||
|
- **移動後必須更新所有引用**,確保不破壞:
|
||||||
|
- 模組間的 `require`/`import` 相對路徑。
|
||||||
|
- `package.json` 的 `main`/`bin`/`scripts`/`exports`(指向 `src/...`)。
|
||||||
|
- `action.yml`/`Dockerfile`/`entrypoint.sh` 內對主程式路徑的引用。
|
||||||
|
- 若 `src/` 下無 `package.json` 而專案需要相依,於 `src/` 建立或移入 `package.json`,`main` 指向入口檔;不擅自新增與功能無關的相依。
|
||||||
|
|
||||||
|
### B3. action.yml 對齊 docker
|
||||||
|
|
||||||
|
將 manifest 的 `runs` 對齊為 docker 容器 action(保留既有 `inputs`/`outputs`/`name`/`description`):
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
runs:
|
||||||
|
using: docker
|
||||||
|
image: Dockerfile
|
||||||
|
```
|
||||||
|
|
||||||
|
- **不設 `runs.entrypoint`**:執行入口由 `Dockerfile` 的 `ENTRYPOINT ["/action/entrypoint.sh"]`(絕對路徑)決定。`runs.entrypoint` 會**覆蓋** Dockerfile 的 `ENTRYPOINT`,且 runner 執行 docker action 時容器工作目錄是使用者 repo 的 workspace(不是 `/action`),相對路徑會找不到檔案。若原 manifest 已有 `entrypoint`,改為絕對路徑(`/action/entrypoint.sh`)或直接移除。
|
||||||
|
- 若原本是 JS action(`using: node*`),改為上述 docker 設定;若已是 docker action,確認 `image` 指向 `Dockerfile`,並依上一點處理 `entrypoint`。
|
||||||
|
- **docker 化代價揭示**(回報即可,不中斷詢問):轉為 docker action 後**僅能在 Linux runner 執行**、每次 workflow 執行多一段 image build 時間、host 模式的 act_runner 無法執行(runner 需具 Docker 能力)。
|
||||||
|
|
||||||
|
改寫主程式或對齊 `action.yml` 過程需要新的參數值(如 token、repo 資訊、外部設定)時,依「參數來源優先序」處理,不逕自新增 `inputs`。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 C:產生 entrypoint.sh(先輸出名稱/用途/更新時間,再啟動 node 主程式)
|
||||||
|
|
||||||
|
在 action 根目錄產生(或覆寫)`entrypoint.sh`:**啟動 node 主程式前,先輸出 action 名稱、用途、更新時間**。
|
||||||
|
|
||||||
|
- **更新時間**依 `/jsc-shared:spec-time-log`(Asia/Taipei、固定 `yyyy/MM/dd HH:mm:ss`、寫成檔內固定字串)。本階段先寫入暫定時間戳,**階段 E 完成後會統一同步各處時間戳**(見階段 E)。
|
||||||
|
- 名稱/用途取自階段 A2 的 `action.yml`。
|
||||||
|
- 最後以 `exec node <主程式>`(如 `exec node /action/src/index.js "$@"`)啟動,讓 node 取代 shell 行程,正確傳遞訊號與 exit code;路徑須與階段 D 的 `Dockerfile` 落點一致。
|
||||||
|
- **若階段 B 裁示「維持非 Node」**:橫幅照常輸出,最後改以 `exec <原直譯器> <主程式>` 啟動(如 `exec python3 /action/src/main.py "$@"`、`exec sh /action/src/main.sh "$@"`)。
|
||||||
|
|
||||||
|
範例(實際路徑依階段 B 入口而定):
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/bin/sh
|
||||||
|
set -e
|
||||||
|
|
||||||
|
# action 啟動橫幅:輸出名稱/用途/更新時間(此檔由 action-docker 產生)
|
||||||
|
echo "================================================"
|
||||||
|
echo "Action : <action name>"
|
||||||
|
echo "用途 : <action description>"
|
||||||
|
echo "更新時間: 2026/06/30 18:30:05"
|
||||||
|
echo "================================================"
|
||||||
|
|
||||||
|
# 啟動 node 主程式(以 exec 取代 shell,正確處理訊號與 exit code)
|
||||||
|
exec node /action/src/index.js "$@"
|
||||||
|
```
|
||||||
|
|
||||||
|
- 賦予可執行權限:`chmod +x entrypoint.sh`(並於 git 標記為可執行)。
|
||||||
|
- 此檔開頭的「用途/更新時間」與每行註解,最終會在階段 E 由 `/jsc-doc:funcs` 的指令檔流程統一補齊/覆寫為標準格式(用途與更新日期同一註解區塊、逐行註解);本階段先確保**執行期輸出**正確即可。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 D:產生 Dockerfile(使用最新 LTS node 版本,六步流程依主程式實作量身產生)
|
||||||
|
|
||||||
|
在 action 根目錄產生(或覆寫)`Dockerfile`,**base image 使用最新 LTS node 版本(固定 major tag)**,採**多階段建置**以縮小最終映像檔。六步流程是**骨架**,但**每一步的實際內容必須依階段 B 的主程式(`src/`)實作決定**——不要套用與主程式無關的固定樣板,也不要硬塞主程式用不到的安裝或建置指令。
|
||||||
|
|
||||||
|
### D0. 先盤點主程式實作需求
|
||||||
|
|
||||||
|
產生 Dockerfile 前,先檢視 `src/` 主程式與 `package.json`,判斷各步該放什麼:
|
||||||
|
|
||||||
|
- **相依套件**:`src/package.json` 的 `dependencies`/`devDependencies`、是否有 lockfile(`package-lock.json`/`npm-shrinkwrap.json`)。決定第 2 步用 `npm ci` 還是 `npm install`、是否需要 dev 相依來 build。
|
||||||
|
- **是否需要 build/transpile**:有無 `scripts.build`、是否為 TypeScript/打包(產物落在 `dist/`/`build/` 等)。決定第 4 步是否要跑建置、第 5 步 runtime 該帶入哪個產物目錄。
|
||||||
|
- **OS 層相依**:主程式是否以 `child_process` 呼叫外部執行檔(如 `git`、`bash`、`openssl`、`python3`、`ffmpeg`、`imagemagick`),或使用需編譯的原生模組(node-gyp/native addon)。決定第 2 步是否要 `apt-get install` 對應套件,以及第 5 步 runtime 基底是否需保留這些執行檔。
|
||||||
|
- **執行期需求**:主程式讀取的環境變數、需存取的檔案路徑、是否寫入暫存目錄。決定 `WORKDIR`、需 `COPY` 的檔案範圍與必要的 `ENV`。
|
||||||
|
- **入口檔**:階段 B 決定的主程式入口(如 `src/index.js`),決定第 6 步與 `entrypoint.sh` 內 `node` 路徑。
|
||||||
|
- **產生 `.dockerignore`**:於 action 根目錄產生(或補齊)`.dockerignore`,至少排除 `.git`、`.docs`、`node_modules`(宿主端,可能含平台不符的原生模組)與其他非執行必需檔案,避免帶進 build context。
|
||||||
|
|
||||||
|
### D1~D6:依盤點結果填入六步
|
||||||
|
|
||||||
|
1. **參數處理**:以 `ARG` 注入 node 版本(預設最新)與主程式需要的 build-time 參數;可調參數集中在檔案開頭。
|
||||||
|
2. **安裝套件**:依 D0 的相依結果安裝——有 lockfile 用 `npm ci`、否則 `npm install`,**二擇一寫死於 Dockerfile**(不得以 `npm ci || npm install` 之類 fallback 串接,避免靜默吞錯、破壞 lockfile 的可重現性);不需 build 時加 `--omit=dev`,需 build 時先裝完整相依(含 dev)供第 4 步使用。**只在主程式真的會用到時**才 `apt-get install` OS 套件,並於同一 `RUN` 清掉 apt 快取。先 `COPY` 相依描述(`package*.json`)再安裝,以利 layer 快取。
|
||||||
|
3. **複製檔案**:`COPY` 主程式實際需要的檔案(`src/`、`entrypoint.sh`,及主程式會讀取的資源),**明列路徑、不整包 `COPY .`**,並配合 `.dockerignore` 排除非必要檔案。
|
||||||
|
4. **執行程序**:賦予 `entrypoint.sh` 執行權限;**僅當 D0 判定需要 build/transpile 時**才執行(如 `npm run build`),否則此步只做權限設定,不要硬加建置指令。
|
||||||
|
5. **縮小映像檔**:多階段建置,runtime 改用 slim 基底,只 `COPY --from=build` 帶入主程式執行**真正需要**的產物——有 build 產物時帶入 `dist/` 與 production `node_modules`(`npm prune --omit=dev` 或重裝 production 相依),純 JS 無 build 時帶入 `src/` 與 production `node_modules`;若 D0 判定 runtime 需要某些 OS 執行檔,於 runtime 階段一併安裝(slim 基底可能不含)。不要把 build 階段的 dev 相依與快取帶進最終映像;**`COPY --from=build` 必須逐項明列路徑,不得整包 `COPY --from=build /action /action`**(整包搬等於沒有縮小)。
|
||||||
|
6. **設定入口**:`ENTRYPOINT` 指向 `entrypoint.sh`,其內 `node` 路徑為 D0 的入口檔。
|
||||||
|
|
||||||
|
base image 版本依 `/jsc-shared:spec-dockerfile`(固定 major tag、不用 `latest`):**預設使用產生當下的最新 LTS major 固定 tag**(如 build 基底 `node:22`、runtime 基底 `node:22-slim`),可查詢 Docker Hub(`https://hub.docker.com/_/node`)確認當前 LTS 版號;帶 `--node-version <tag>` 時改用 `node:<tag>` 與 `node:<tag>-slim`。
|
||||||
|
|
||||||
|
下列為**最簡基準骨架**(純 JS、無 build、無 OS 相依的情況);實際內容須依 D0 盤點調整,第 4 步建置、第 2/5 步 OS 套件等視主程式需要增刪:
|
||||||
|
|
||||||
|
```Dockerfile
|
||||||
|
# 1. 參數處理:node 版本以 ARG 注入(預設當前最新 LTS major,範例為 22;--node-version 可覆寫)
|
||||||
|
ARG NODE_VERSION=22
|
||||||
|
ARG NODE_RUNTIME=22-slim
|
||||||
|
|
||||||
|
# ---- build 階段:安裝相依、準備產物 ----
|
||||||
|
FROM node:${NODE_VERSION} AS build
|
||||||
|
WORKDIR /action
|
||||||
|
|
||||||
|
# 2. 安裝套件:先帶相依描述以利 layer 快取,再裝 src/ 相依
|
||||||
|
# (依 D0 盤點二擇一寫死:有 lockfile 用 npm ci、否則 npm install,不用 || 串接;
|
||||||
|
# 需 build 時改裝完整相依;需 OS 套件時於此 apt-get install 並清快取)
|
||||||
|
COPY src/package*.json /action/src/
|
||||||
|
RUN if [ -f /action/src/package.json ]; then \
|
||||||
|
cd /action/src && npm ci --omit=dev; \
|
||||||
|
fi
|
||||||
|
|
||||||
|
# 3. 複製檔案:明列主程式實際需要的檔案(配合 .dockerignore,不整包 COPY .)
|
||||||
|
COPY src/ /action/src/
|
||||||
|
COPY entrypoint.sh /action/entrypoint.sh
|
||||||
|
|
||||||
|
# 4. 執行程序:賦予 entrypoint 執行權限(D0 判定需要 build 時於此 npm run build)
|
||||||
|
RUN chmod +x /action/entrypoint.sh
|
||||||
|
|
||||||
|
# 5. 縮小映像檔:多階段建置,runtime 改用 slim 基底,逐項明列只帶執行真正需要的產物
|
||||||
|
# (有 build 產物時改帶 dist/ 與 production node_modules;runtime 需要的 OS 執行檔於此安裝)
|
||||||
|
FROM node:${NODE_RUNTIME} AS runtime
|
||||||
|
WORKDIR /action
|
||||||
|
COPY --from=build /action/src /action/src
|
||||||
|
COPY --from=build /action/entrypoint.sh /action/entrypoint.sh
|
||||||
|
|
||||||
|
# 6. 設定入口:以 entrypoint.sh 啟動(其內 node 指向 D0 的入口檔)
|
||||||
|
ENTRYPOINT ["/action/entrypoint.sh"]
|
||||||
|
```
|
||||||
|
|
||||||
|
- **依主程式實作**:上面只是基準骨架。若主程式是 TypeScript/需打包,第 4 步要加 `npm run build`、第 5 步只帶 `dist/` 與 production 相依;若主程式會 spawn 外部執行檔或用原生模組,第 2/5 步要補對應 OS 套件;用不到的步驟內容不要硬塞。
|
||||||
|
- **若階段 B 裁示「維持非 Node」**:base image 改用對應語言官方映像(如 `python:3-slim`),第 2 步改安裝該生態相依(如 `pip install -r requirements.txt`),其餘六步結構不變;`ENTRYPOINT` 仍指向 `entrypoint.sh`(其內 `exec` 原直譯器,見階段 C)。
|
||||||
|
- **版號對齊**:依 `/jsc-shared:spec-dockerfile`(runtime 與 build 版號一致、以獨立 runtime ARG 帶入不用 `${VERSION}-slim` 組裝、`-alpine`/`-slim` 變體沿用同一 tag、使用者要求 `latest` 時 runtime 用 `node:slim`)。
|
||||||
|
- **自我檢查**:`entrypoint.sh` 的 `node <主程式>` 路徑(如 `/action/src/index.js`)需與 `Dockerfile` 的 `WORKDIR`/`COPY` 落點一致,避免容器啟動時找不到主程式;`action.yml` 的 `runs.entrypoint` 若存在,必須是**絕對路徑**且與 `Dockerfile` 落點一致(預設不設,讓 Dockerfile 的 `ENTRYPOINT` 生效)。
|
||||||
|
- 此檔的用途/更新日期註解與逐行註解,同樣於階段 E 由 funcs 指令檔流程統一補齊。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 E:完整執行 /jsc-doc:funcs 處理流程
|
||||||
|
|
||||||
|
容器化與 Node 化完成後,以階段 A1 的 action 根目錄為目標,依 `/jsc-shared:spec-doc-funcs-handoff` 對**整個 action 專案**完整執行 `/jsc-doc:funcs` 流程(前置可用性檢查、完整流程、由使用者裁示實作方式、重建 README;本次新增/變更的 `entrypoint.sh`、`Dockerfile` 與 `src/` 內 Node 主程式都會被涵蓋)。完成後依該 spec **統一時間戳**:回頭同步 `entrypoint.sh` 橫幅輸出與註解區塊、`Dockerfile` 註解區塊與 README 的更新時間,確保各處一致。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 總結
|
||||||
|
|
||||||
|
各階段執行後輸出:
|
||||||
|
|
||||||
|
- **階段 A**:action 根目錄、action 名稱/用途、原主程式檔與語言、是否為 Node;若走 A1a 從零建立,列出問答收集結果(名稱/輸入輸出/目標)。
|
||||||
|
- **階段 B**:是否改寫主程式(及改寫摘要與「需人工確認」清單)、搬入 `src/` 的 `.js` 清單、已更新的引用(`package.json`/`action.yml`/路徑);依「參數來源優先序」新增的 `inputs` 清單與呼叫端傳入寫法(若有)。
|
||||||
|
- **階段 C/D**:`entrypoint.sh` 的輸出內容(名稱/用途/更新時間)與啟動的 node 主程式、`Dockerfile` 採用的 node 版本與 `ENTRYPOINT`。
|
||||||
|
- **階段 E**:funcs 流程的處理結果(文件化的 function 與指令檔、重建的 README)。
|
||||||
|
- 列出本次新增/變更的檔案與其相對路徑,並提醒使用者於提交前確認 `entrypoint.sh` 有可執行權限、容器能正確啟動。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 呼叫方式
|
||||||
|
|
||||||
|
格式:`[--action-dir <action 根目錄>] [--node-version <node tag>] [--main <主程式檔>]` — 全部可省略(根目錄預設目前工作目錄;node 版本預設最新 LTS;主程式自動判斷)。
|
||||||
|
|
||||||
|
| 助理 | 呼叫 |
|
||||||
|
| --- | --- |
|
||||||
|
| Claude Code / Antigravity | `/jsc-code:action-docker`,或 `/jsc-code:action-docker --action-dir ~/work/my-action --node-version 22` |
|
||||||
|
| Codex | `$action-docker`,或 `$action-docker --action-dir ~/work/my-action`,或用 `/skills` 選單 |
|
||||||
|
| OpenCode | 描述需求(如「把這個 action 主程式改成 node、主程式相關 js 收進 src/,產生會先輸出 action 名稱/用途/更新時間再啟動 node 的 entrypoint.sh、用最新 LTS node 版本的 Dockerfile,最後跑 funcs 補文件並重建 README」)自動觸發 |
|
||||||
@@ -0,0 +1,251 @@
|
|||||||
|
---
|
||||||
|
name: action-node
|
||||||
|
description: 將 Gitea/GitHub「Node(JavaScript)action」專案標準化(目錄沒有 action manifest 時可問答式從零建立),並串接文件化流程:(1) 檢查 action 主程式是否為 Node,否則保守改寫為 Node,且主程式及其依賴鏈的 `.js` 檔集中到 `src/` 資料夾(工具設定檔與測試目錄不搬);(2) 對齊 `action.yml` 為 node action(`runs.using` 設為 `node24`、指定 `runs.main`,`outputs` 只留 `description` 不設 `value`,`inputs` 由 runner 自動注入 `INPUT_*`),並在主程式入口最前面輸出 action 名稱/用途/更新時間橫幅;(3) 處理相依打包——零相依則 `main` 直接指向 `src/index.js`,有相依則以 `@vercel/ncc` 打包成 `dist/index.js`、`main` 改指 `dist/index.js` 並將 `dist/` commit 進 repo(runner 不會自動 `npm install`);(4) 開發中需要新參數時優先取用 runner 注入的 `GITHUB_*`(Gitea 亦有 `GITEA_*`)執行期環境變數,無法取得才詢問使用者是否新增 `inputs`(`secrets`/`vars` 一律視為不可用,需要時宣告為 `inputs` 由呼叫端 workflow 傳入);(5) 最後完整執行 `/jsc-doc:funcs` 處理流程(function 文件、指令檔逐行註解、重建 README)。當使用者說把 action 改成 node/JavaScript action、從零建立/產生一個 node action、action 主程式 node 化、把 js 收進 src、用 ncc 打包 action、處理 node action 相依或參數來源,或提到 action-node 時觸發。不適用於:Docker 容器 action(用 action-docker)、composite action(用 action-composite)、只整理既有 Dockerfile(用 image)、或不需 action 化/文件化的一般 repo。
|
||||||
|
argument-hint: "[--action-dir <action 根目錄>] [--node-version <node runtime,如 node24>] [--main <主程式檔>]"
|
||||||
|
---
|
||||||
|
|
||||||
|
# action-node — Node(JavaScript)action 標準化+文件化
|
||||||
|
|
||||||
|
五階段 skill:先做**前置設定與偵測**(找出 action 專案、讀取名稱/用途、判斷主程式語言),再把**主程式 Node 化並將主程式依賴鏈的 `.js` 收進 `src/`**,接著**對齊 `action.yml` 為 node action 並在主程式入口最前面注入輸出名稱/用途/更新時間的啟動橫幅**,然後**處理相依打包**(零相依直接跑 `src/`,有相依以 `@vercel/ncc` 打包成 `dist/` 並 commit),最後**完整執行 `/jsc-doc:funcs` 處理流程**替整個專案補文件並重建 README。產出的 node action 由 **runner 內建的 Node runtime 直接執行 `runs.main`**(不需 Docker、啟動比 docker action 快)。各階段開發中需要新參數時,一律套用下方「**參數來源優先序**」規則。目錄沒有 action manifest 時,先走 A1a 問答式「**從零建立**」分支產生 `action.yml` 與 Node 主程式骨架,再進入後續階段。
|
||||||
|
|
||||||
|
| 階段 | 動作 |
|
||||||
|
| --- | --- |
|
||||||
|
| A. 前置設定與偵測 | 決定 action 根目錄 → 讀 `action.yml`/`action.yaml` 的 `name`/`description` → 判斷目前主程式與語言(無 manifest 可走 A1a 從零建立) |
|
||||||
|
| B. 主程式 Node 化 | 主程式非 Node 則**保守改寫**為 Node(高風險,先確認)→ 主程式依賴鏈的 `.js` 集中到 `src/`,更新所有引用、`package.json`、`action.yml` |
|
||||||
|
| C. 對齊 action.yml + 啟動橫幅 | `runs` 對齊 node action(`using: node24` + `main`)、`outputs` 去除 `value`、`inputs` 契約保留;在主程式入口最前面輸出 action **名稱/用途/更新時間** |
|
||||||
|
| D. 相依處理與打包 | 零相依 → `main` 指 `src/index.js`;有相依 → `ncc build` 成 `dist/index.js`、`main` 改指 `dist/index.js`、`dist/` commit 進 repo(runner 不會 `npm install`) |
|
||||||
|
| E. 串接 funcs | 對整個 action 專案完整執行 `/jsc-doc:funcs` 流程(function 文件、指令檔逐行註解、重建 README) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 共用規範(shared plugin,必要前置)
|
||||||
|
|
||||||
|
執行本 skill 前,先以 Skill 工具載入下列共用規範並全程遵守;**任一載入不到(shared plugin 未安裝)時,先詢問使用者是否安裝 shared plugin(`https://gitea.jsc.idv.tw/plugins/shared.git`),使用者不安裝則直接中斷本 skill**,不得只憑下方一行摘要繼續執行:
|
||||||
|
|
||||||
|
- `/jsc-shared:spec-output`:繁體中文(台灣用語)、UTF-8(不含 BOM)無亂碼。
|
||||||
|
- `/jsc-shared:spec-execution`:自動執行原則(必要決策才中斷)、不臆測/需人工確認、不擴及無關檔案。
|
||||||
|
- `/jsc-shared:spec-git-safety`:不破壞既有工作(絕不 `reset --hard`/`clean`)、`git mv` 保留歷史。
|
||||||
|
- `/jsc-shared:spec-action-params`:action 參數來源優先序(環境變數 → 經同意新增 `inputs`)、`secrets`/`vars` 一律視為不可用。
|
||||||
|
- `/jsc-shared:spec-time-log`:更新時間 Asia/Taipei `yyyy/MM/dd HH:mm:ss`、完成後統一同步時間戳。
|
||||||
|
- `/jsc-shared:spec-doc-funcs-handoff`:最終階段完整執行 `/jsc-doc:funcs` 的標準流程。
|
||||||
|
|
||||||
|
本 skill 特有補充:
|
||||||
|
|
||||||
|
- **一定會中斷詢問的點**:階段 B 主程式「非 Node 需改寫」時(破壞性,須先確認),階段 D「新增 `@vercel/ncc` 等 build 相依」時(依 `/jsc-shared:spec-action-params` 經同意),以及階段 E 由 `/jsc-doc:funcs` 自身的「如何實作」詢問。
|
||||||
|
- **保留行為**:Node 化只「翻譯」既有邏輯,不得擅自改變對外行為、輸入輸出契約或副作用;任何無法可靠等價推論的改動一律不做,並以註解或回報標註「需人工確認」。新增 `input` 僅限依 `/jsc-shared:spec-action-params` 經使用者同意後為之。
|
||||||
|
- **本 skill 只動**:action 專案根目錄內的主程式、主程式依賴鏈的 `.js`(搬移到 `src/`)、`package.json`(含 `scripts.build`)、`action.yml`/`action.yaml`、打包產物 `dist/`、`.gitignore`(確保 `dist/` 不被忽略),以及階段 E 由 funcs 流程處理的目標。**不產生** `Dockerfile`/`entrypoint.sh`(那是 action-docker 的範疇)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 三種 action 的分工(先確認選對 skill)
|
||||||
|
|
||||||
|
| 型態 | `runs.using` | 執行方式 | 對應 skill |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| **node(本 skill)** | `node24`/`node20`… | runner 內建 Node 直接跑 `main` 指定的 `.js`;**不會 `npm install`** | `action-node` |
|
||||||
|
| composite | `composite` | 依序執行 `steps`(純 YAML 組合) | `action-composite` |
|
||||||
|
| docker | `docker` | 建 image、於容器內執行(可 `npm ci`) | `action-docker` |
|
||||||
|
|
||||||
|
node action 相對 docker/composite 的**關鍵差異**(全程據此處理):
|
||||||
|
|
||||||
|
1. **相依不會自動安裝**:runner 不在 action repo 內跑 `npm install`。要嘛**零相依**,要嘛把相依**打包/commit 進 repo**(見階段 D)。
|
||||||
|
2. **無 `entrypoint.sh`/`Dockerfile`**:啟動橫幅改由**主程式(JS)最前面 `console.log` 輸出**,不另外產生 shell 入口。
|
||||||
|
3. **`inputs` 自動注入**:runner 會把每個 input 轉成 `INPUT_<NAME>` 環境變數(名稱轉大寫、空白換底線),JS 內以 `process.env.INPUT_<NAME>` 或 `core.getInput('<name>')` 取值;composite 需手動映射,node **不用**。
|
||||||
|
4. **`outputs` 只需 `description`**:實際值在執行時由程式寫入 `$GITHUB_OUTPUT`(或 `core.setOutput`),`action.yml` 的 `outputs` **不設也不該有 `value`**(那是 composite 的寫法)。
|
||||||
|
5. **`required: true` 不會自動擋、input 一律字串**:必填檢查與型別轉換都要在程式裡自己做。
|
||||||
|
6. **`main` 路徑相對 action 根目錄**:讀 action 自帶檔案用 `__dirname` 或 `process.env.GITHUB_ACTION_PATH` 定位,不要用相對呼叫端工作目錄的路徑。
|
||||||
|
7. **node 專屬的 `pre`/`post`**:可用 `runs.pre`/`runs.post`(`pre` 不支援 `uses: ./` 的 local action);composite/docker 沒有。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 參數來源優先序(開發中需要新參數時)
|
||||||
|
|
||||||
|
從零建立(A1a)、主程式 Node 化(階段 B)、對齊 `action.yml`(階段 C)或打包(階段 D)的過程中,若需要新的參數值,一律依 `/jsc-shared:spec-action-params` 的優先序處理:node action 主程式優先取 runner 注入的執行期環境變數(`process.env.GITHUB_*`;Gitea 亦提供 `GITEA_*` 同義變數,建議讀 `GITHUB_*` 以相容兩邊),既有 `inputs` 以 `process.env.INPUT_<大寫名稱>`(或 `core.getInput`)取用,取不到才以 `AskUserQuestion` 經使用者同意新增 `inputs`(由呼叫端 workflow 以 `with:` 傳入);`secrets`/`vars` 一律視為不可用,需要時宣告為 `input` 由呼叫端傳入(範例見該 spec)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 參數
|
||||||
|
|
||||||
|
格式:`[--action-dir <action 根目錄>] [--node-version <node runtime>] [--main <主程式檔>]`
|
||||||
|
|
||||||
|
- `--action-dir <action 根目錄>`:action 專案根目錄。**省略時預設目前工作目錄**(須含 `action.yml`/`action.yaml`,否則依 A1 詢問)。
|
||||||
|
- `--node-version <node runtime>`:`action.yml` 的 `runs.using` node runtime(如 `node24`、`node20`)。**省略時預設 `node24`**(現行最新,本生態範本採用);`node24` 需較新的 act runner,runner 太舊會報 `The runs.using key ... got node24`,此時升級 act runner 或退回 `node20`(見階段 C)。
|
||||||
|
- `--main <主程式檔>`:指定主程式入口檔(相對 action 根目錄)。省略時依 A3 自動判斷。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 A:前置設定與偵測
|
||||||
|
|
||||||
|
### A1. 決定 action 根目錄
|
||||||
|
|
||||||
|
- 帶 `--action-dir` → 採用(展開 `~`)。
|
||||||
|
- 省略 → 用目前工作目錄。
|
||||||
|
- 根目錄須存在 `action.yml` 或 `action.yaml`(action manifest)。**找不到** action manifest → **不臆測**、不逕自動工;以 `AskUserQuestion` 詢問使用者要「**從零建立**新的 Node action」還是「提供正確的 action 路徑」:選「從零建立」→ 進入 A1a;選「提供路徑」→ 依新路徑重跑 A1。
|
||||||
|
|
||||||
|
### A1a. 從零建立 Node action(問答式)
|
||||||
|
|
||||||
|
依序以問答收集需求,再產生 manifest 與主程式骨架:
|
||||||
|
|
||||||
|
1. **action 名稱**:用於 `action.yml` 的 `name`。
|
||||||
|
2. **輸入與輸出參數**:逐一收集 `inputs`(名稱、`description`、`required`、`default`)與 `outputs`(名稱、`description`;**不收集 `value`**);description 盡量繁體中文、無亂碼;沒有可留空。
|
||||||
|
3. **執行目標**:詢問此 action 要達成什麼,整理濃縮成一句話作為 `action.yml` 的 `description`(盡量繁體中文、無亂碼)。
|
||||||
|
|
||||||
|
收集完成後,於 action 根目錄產生:`action.yml`(`runs.using: node24`、`runs.main: src/index.js`,含收集到的 `name`/`description`/`inputs`/`outputs`)與 `src/index.js` 主程式(依執行目標以 Node 實作,輸入以 `process.env.INPUT_<NAME>` 讀取、輸出以附加寫入 `process.env.GITHUB_OUTPUT`,開發中需要新參數時套用「參數來源優先序」);預設走**零相依**路線。完成後接續 A2 往後流程(A3 判定為 Node,階段 B 走「已是 Node」分支,階段 C/D 照常對齊 manifest 與處理相依)。
|
||||||
|
|
||||||
|
### A2. 讀取 action 名稱與用途
|
||||||
|
|
||||||
|
從 action manifest 讀取:
|
||||||
|
|
||||||
|
- `name`:action 名稱(供啟動橫幅與 README 使用)。
|
||||||
|
- `description`:action 用途。
|
||||||
|
- `runs`:目前的執行設定(`using`、`main`、`image`、`entrypoint`、`steps` 等)。
|
||||||
|
- `inputs`/`outputs`:對外契約(後續不得破壞)。
|
||||||
|
|
||||||
|
若 `name`/`description` 缺漏,回報並請使用者補;無法取得時於後續輸出以「(未提供)」保守標示,**不編造**。
|
||||||
|
|
||||||
|
### A3. 判斷目前主程式與語言
|
||||||
|
|
||||||
|
依序判斷主程式入口(取第一個成立者):
|
||||||
|
|
||||||
|
1. 帶 `--main <主程式檔>` → 直接採用。
|
||||||
|
2. `action.yml` 為 JS action(`runs.using: node*`)→ 取 `runs.main`。
|
||||||
|
3. `action.yml` 為 docker action(`runs.using: docker`)→ 看 `runs.entrypoint`/`Dockerfile` 的 `ENTRYPOINT`/`CMD` 推主程式(並提醒:轉為 node action 會**移除容器化**,若原本刻意用 docker,宜改用 `action-docker`)。
|
||||||
|
4. `action.yml` 為 composite(`runs.using: composite`)→ 從 `steps` 內實際執行的指令推主程式(提醒:composite 轉 node 屬破壞性改寫)。
|
||||||
|
5. 以上皆無 → 依專案檔與副檔名分布推斷(`package.json` 的 `main`/`bin`、`index.js`、`*.sh`、`*.py` 等)。
|
||||||
|
|
||||||
|
判定**主程式是否為 Node**:入口為 `.js`/`.mjs`/`.cjs` 且由 `node` 執行即視為 Node;入口為 shell/python/其他則視為非 Node。輸出偵測結果(action 名稱、用途、主程式檔、判定語言、是否為 Node、目前 `runs.using`),再進入階段 B。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 B:主程式 Node 化,並將主程式依賴鏈的 `.js` 收進 `src/`
|
||||||
|
|
||||||
|
### B1. 主程式 Node 化
|
||||||
|
|
||||||
|
- **已是 Node** → 確認入口檔,不改寫邏輯,直接進 B2。
|
||||||
|
- **非 Node(shell/python/其他)** → 這是**破壞性高風險決策**:先以 `AskUserQuestion` 向使用者確認是否改寫為 Node,選項至少含「改寫為 Node」「改用 action-docker(維持原語言容器化)」「其他」。經確認後才改寫:
|
||||||
|
- 逐段把原主程式邏輯**保守翻譯**為 Node(建議 `src/index.js`);保留對外行為、輸入(環境變數/`INPUT_*`/args)與輸出(`$GITHUB_OUTPUT`/stdout/exit code/檔案副作用)契約。
|
||||||
|
- 外部指令呼叫以 `child_process`(`execFileSync`/`spawnSync`)對應;檔案操作以 `fs`;環境變數以 `process.env`。
|
||||||
|
- 任何無法可靠等價翻譯處,**不臆測**:以 `// 需人工確認:...` 標註並回報。
|
||||||
|
- 改寫完成後,原非 Node 主程式於 B2 一併處理(移除或保留由使用者裁示;預設保留並在 README/回報標註已由 Node 取代)。
|
||||||
|
|
||||||
|
### B2. 主程式依賴鏈的 `.js` 集中到 `src/`
|
||||||
|
|
||||||
|
- 在 action 根目錄建立 `src/`(若不存在)。
|
||||||
|
- 將**主程式入口及其 `require`/`import` 依賴鏈**的 `.js`/`.mjs`/`.cjs`(排除 `node_modules`/`.git`/`.docs`/`dist`/第三方依賴)**移入 `src/`**,優先 `git mv` 保留歷史。主程式入口統一為 `src/index.js`(或 `src/<main>.js`)。
|
||||||
|
- **明文排除、不搬**:外部工具依慣例路徑尋找的檔案——`*.config.js`(`eslint.config.js`/`jest.config.js`/`ncc` 等工具設定)、`.*rc.js`、husky/commitlint 等工具設定,以及 `test/`/`tests/`/`scripts/` 目錄;搬走會弄壞 lint/test/build 流程。
|
||||||
|
- **移動後必須更新所有引用**,確保不破壞:
|
||||||
|
- 模組間的 `require`/`import` 相對路徑。
|
||||||
|
- `package.json` 的 `main`/`bin`/`scripts`/`exports`(指向 `src/...`;`scripts.build` 的 ncc 入口指向 `src/index.js`)。
|
||||||
|
- `action.yml` 的 `runs.main`(先指向 `src/index.js`;若階段 D 判定需打包,再改指 `dist/index.js`)。
|
||||||
|
- 若 `src/` 需要的相依尚未宣告,於 `package.json` 補上;不擅自新增與功能無關的相依(`@vercel/ncc` 屬階段 D 的 build 相依,經同意後才加)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 C:對齊 action.yml 為 node action,並注入啟動橫幅
|
||||||
|
|
||||||
|
### C1. 對齊 `runs` 為 node action
|
||||||
|
|
||||||
|
將 manifest 的 `runs` 對齊為 node(JavaScript)action,**保留既有 `inputs`/`outputs`/`name`/`description`**:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
runs:
|
||||||
|
using: 'node24' # 見版本說明;--node-version 可覆寫、runner 太舊退 node20
|
||||||
|
main: 'src/index.js' # 有相依打包後於階段 D 改為 'dist/index.js'
|
||||||
|
```
|
||||||
|
|
||||||
|
- **`using` 版本**依 `/jsc-shared:spec-time-log` 之外另遵循版本規則:**預設 `node24`**(現行最新、本生態範本採用),帶 `--node-version` 時改用指定值。`node24` 需較新的 act runner;runner 太舊會報 `The runs.using key in action.yml must be one of: [composite docker node12 node16 node20 go], got node24`——此時**升級 act runner**,或(回報後)暫時退回 `node20`。**不用**沒有意義的 `latest`。
|
||||||
|
- **`outputs` 去 `value`**:node action 的 `outputs.<name>` 只保留 `description`,**移除**任何 `value: ${{ steps.* }}`(那是 composite 寫法);實際值於執行時由程式寫入 `$GITHUB_OUTPUT`。
|
||||||
|
- **`inputs` 契約保留**:不更動既有 `inputs` 名稱/`required`/`default`;主程式以 `process.env.INPUT_<大寫名稱>`(或 `core.getInput`)取用,runner 會自動注入,**不需**像 composite 手動映射 `env:`。
|
||||||
|
- 原本是 **docker/composite** action 改為 node 時,一併移除只服務原型態的欄位(`image`/`entrypoint`/`steps`),並在回報標示型態已變更;無法可靠等價轉換處以 `# 需人工確認` 標註、不臆測。
|
||||||
|
- 選填的 `runs.pre`/`runs.post`(node 專屬)僅在原本已有、或使用者明確要求時才設定;`pre` 不支援 `uses: ./` 的 local action。
|
||||||
|
|
||||||
|
### C2. 注入啟動橫幅(主程式入口最前面輸出名稱/用途/更新時間)
|
||||||
|
|
||||||
|
node action 沒有 `entrypoint.sh`,橫幅改由**主程式 JS 最前面輸出**。在 `src/index.js`(或階段 B 決定的入口)最上方,於任何其他邏輯**之前**插入(或更新)橫幅輸出:
|
||||||
|
|
||||||
|
- **更新時間**依 `/jsc-shared:spec-time-log`(Asia/Taipei、固定 `yyyy/MM/dd HH:mm:ss`、寫成檔內固定字串)。本階段先寫入暫定時間戳,**階段 E 完成後會統一同步各處時間戳**(見階段 E)。
|
||||||
|
- 名稱/用途取自階段 A2 的 `action.yml`(缺漏時以「(未提供)」標示)。
|
||||||
|
- 若已存在本 skill 先前插入的橫幅(依可辨識註解標記),則**更新**其內容與時間戳,不重複插入。
|
||||||
|
|
||||||
|
範例(純 `console.log`、零相依;用 `@actions/core` 時可改 `core.info`):
|
||||||
|
|
||||||
|
```js
|
||||||
|
// action 啟動橫幅:輸出名稱/用途/更新時間(此區塊由 action-node 維護)
|
||||||
|
console.log('================================================');
|
||||||
|
console.log('Action : <action name>');
|
||||||
|
console.log('用途 : <action description>');
|
||||||
|
console.log('更新時間: 2026/07/17 12:00:00');
|
||||||
|
console.log('================================================');
|
||||||
|
```
|
||||||
|
|
||||||
|
- 橫幅只做輸出,**不得**改變既有主邏輯的執行順序或副作用。
|
||||||
|
- 此區塊的「用途/更新時間」與檔內註解,最終會在階段 E 由 `/jsc-doc:funcs` 的指令檔/function 流程統一補齊/覆寫為標準格式;本階段先確保**執行期輸出**正確即可。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 D:相依處理與打包(零相依直接跑 src/,有相依用 ncc 打包成 dist/)
|
||||||
|
|
||||||
|
node action 的 runner **不會自動 `npm install`**,因此相依必須隨 repo 提供。先盤點主程式相依,再二擇一:
|
||||||
|
|
||||||
|
### D0. 盤點相依
|
||||||
|
|
||||||
|
檢視 `src/` 主程式與 `package.json` 的 `dependencies`:
|
||||||
|
|
||||||
|
- **完全零相依**(只用 Node 內建模組,如 `fs`/`os`/`path`/`child_process`)→ 走 D1。
|
||||||
|
- **有第三方相依**(如 `@actions/core`/`@actions/github` 或其他 npm 套件)→ 走 D2 打包。
|
||||||
|
|
||||||
|
### D1. 零相依:main 直接指 src/index.js
|
||||||
|
|
||||||
|
- 確認 `action.yml` 的 `runs.main: src/index.js`,**不需** build 步驟、**不需** `dist/`。
|
||||||
|
- `package.json` 可保留(或補上)`scripts.build`(`ncc build src/index.js -o dist`)備用,但零相依情況不必執行。
|
||||||
|
|
||||||
|
### D2. 有相依:以 @vercel/ncc 打包成 dist/ 並 commit
|
||||||
|
|
||||||
|
打包能把原始碼與相依編成單一檔,避免 commit 龐大的 `node_modules`:
|
||||||
|
|
||||||
|
1. 新增 build 相依(依 `/jsc-shared:spec-action-params`/本 skill「一定會中斷詢問的點」,屬新增相依,先向使用者確認):`npm i -D @vercel/ncc`,並確保 `package.json` 有:
|
||||||
|
```json
|
||||||
|
"scripts": { "build": "ncc build src/index.js -o dist" }
|
||||||
|
```
|
||||||
|
2. 執行打包產生 `dist/index.js`:`npx ncc build src/index.js -o dist`。
|
||||||
|
3. 將 `action.yml` 的 `runs.main` 改為 `dist/index.js`。
|
||||||
|
4. **把 `dist/` commit 進 repo**:確認 `.gitignore` **沒有**忽略 `dist/`(若有,移除該規則或加 `!dist/`),並 `git add dist/`。
|
||||||
|
5. 於回報提醒:**每次改 `src/` 都要重新 `ncc build` 並提交 `dist/`**,否則 action 執行的是舊版打包產物。
|
||||||
|
|
||||||
|
> 另一可行但不建議的做法:直接 commit `node_modules`(體積大、跨平台原生模組易出問題)。預設採用 ncc 打包。
|
||||||
|
|
||||||
|
### D3. 版本與自我檢查
|
||||||
|
|
||||||
|
- `runs.main` 指向的檔案(`src/index.js` 或 `dist/index.js`)必須**確實存在於 repo**、且為 runner 可直接執行的 JS。
|
||||||
|
- `runs.using` 的 node 版本需與目標 runner 相容(見階段 C)。
|
||||||
|
- 橫幅輸出、`INPUT_*` 讀取、`$GITHUB_OUTPUT` 寫入在打包後仍正確(ncc 打包不改執行語意,但入口路徑改變,確認 `main` 已同步更新)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 E:完整執行 /jsc-doc:funcs 處理流程
|
||||||
|
|
||||||
|
標準化與打包完成後,以階段 A1 的 action 根目錄為目標,依 `/jsc-shared:spec-doc-funcs-handoff` 對**整個 action 專案**完整執行 `/jsc-doc:funcs` 流程(前置可用性檢查、完整流程、由使用者裁示實作方式、重建 README;本次新增/變更的 `src/` 內 Node 主程式、`action.yml`、`package.json` 都會被涵蓋)。完成後依該 spec **統一時間戳**:回頭同步主程式橫幅輸出與註解區塊、`action.yml` 開頭註解區塊與 README 的更新時間,確保各處一致。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 總結
|
||||||
|
|
||||||
|
各階段執行後輸出:
|
||||||
|
|
||||||
|
- **階段 A**:action 根目錄、action 名稱/用途、原主程式檔與語言、是否為 Node、目前 `runs.using`;若走 A1a 從零建立,列出問答收集結果(名稱/輸入輸出/目標)。
|
||||||
|
- **階段 B**:是否改寫主程式(及改寫摘要與「需人工確認」清單)、搬入 `src/` 的 `.js` 清單、已更新的引用(`package.json`/`action.yml`/路徑);依「參數來源優先序」新增的 `inputs` 清單與呼叫端傳入寫法(若有)。
|
||||||
|
- **階段 C**:對齊後的 `runs`(`using`/`main`)、`outputs` 是否已去除 `value`、`inputs` 契約保留情形、橫幅輸出內容(名稱/用途/更新時間)與插入位置。
|
||||||
|
- **階段 D**:相依判定(零相依/打包)、是否新增 `@vercel/ncc`、`runs.main` 最終指向(`src/index.js` 或 `dist/index.js`)、`dist/` 是否已 commit。
|
||||||
|
- **階段 E**:funcs 流程的處理結果(文件化的 function 與指令檔、重建的 README)。
|
||||||
|
- 列出本次新增/變更的檔案與其相對路徑,並提醒使用者於提交前確認 `runs.main` 檔案存在、(打包時)`dist/` 已提交、目標 runner 支援指定的 node 版本。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 呼叫方式
|
||||||
|
|
||||||
|
格式:`[--action-dir <action 根目錄>] [--node-version <node runtime>] [--main <主程式檔>]` — 全部可省略(根目錄預設目前工作目錄;node 版本預設 `node24`;主程式自動判斷)。
|
||||||
|
|
||||||
|
| 助理 | 呼叫 |
|
||||||
|
| --- | --- |
|
||||||
|
| Claude Code / Antigravity | `/jsc-code:action-node`,或 `/jsc-code:action-node --action-dir ~/work/my-action --node-version node24` |
|
||||||
|
| Codex | `$action-node`,或 `$action-node --action-dir ~/work/my-action`,或用 `/skills` 選單 |
|
||||||
|
| OpenCode | 描述需求(如「把這個 action 主程式改成 node、主程式相關 js 收進 src/,對齊 action.yml 為 node action、在主程式最前面輸出 action 名稱/用途/更新時間,有相依就用 ncc 打包成 dist 並 commit,最後跑 funcs 補文件並重建 README」)自動觸發 |
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
---
|
|
||||||
name: hello
|
|
||||||
description: 範例 skill,用來驗證 jsc plugin 是否安裝成功,也是新增 skill 的範本。當使用者輸入 hello、想測試 plugin、或想看 skill 模板長什麼樣子時觸發;回覆一句問候並簡述此 plugin 的用途。
|
|
||||||
---
|
|
||||||
|
|
||||||
# hello(範例 skill)
|
|
||||||
|
|
||||||
這是 `jsc` plugin 的範例 skill。它有兩個用途:
|
|
||||||
|
|
||||||
1. **驗證安裝** — 跨各家 AI 助理確認 skill 已被正確載入。
|
|
||||||
2. **作為範本** — 複製這個資料夾即可新增一個新的 skill。
|
|
||||||
|
|
||||||
## 呼叫方式
|
|
||||||
|
|
||||||
| 助理 | 呼叫方式 |
|
|
||||||
| --- | --- |
|
|
||||||
| Claude Code | `/jsc:hello` |
|
|
||||||
| Antigravity | `/jsc:hello`,或描述需求自動觸發 |
|
|
||||||
| Codex | 在提示詞輸入 `$hello`,或用 `/skills` 選單 |
|
|
||||||
| OpenCode | 直接描述需求,模型會透過 skill 工具自動呼叫 |
|
|
||||||
|
|
||||||
## 行為
|
|
||||||
|
|
||||||
當這個 skill 被觸發時:
|
|
||||||
|
|
||||||
1. 回覆「Hello from **jsc** 👋」。
|
|
||||||
2. 用一句話說明 `jsc` 是一個跨 AI 助理的共用 skill 集合。
|
|
||||||
3. 提示使用者可以在 README 的「Skills 目錄」查看所有可用的 skills。
|
|
||||||
|
|
||||||
## 如何以此為範本新增 skill
|
|
||||||
|
|
||||||
1. 複製 `skills/hello/` 為 `skills/<your-skill-name>/`。
|
|
||||||
2. 修改 `SKILL.md` 的 frontmatter:
|
|
||||||
- `name`:小寫、數字、連字號(`-`),最長 64 字元。**這個名稱會成為 Claude Code / Antigravity 的 `/jsc:<name>` 指令**。
|
|
||||||
- `description`:第三人稱,寫清楚「什麼時候該用、什麼時候不該用」與觸發關鍵字 — 各家助理靠這段文字決定是否自動載入。
|
|
||||||
3. 在內文寫下 skill 的具體步驟。
|
|
||||||
4. 手動把新 skill 補進 README 的「Skills 目錄」區塊。
|
|
||||||
@@ -0,0 +1,154 @@
|
|||||||
|
---
|
||||||
|
name: image
|
||||||
|
description: 把專案的 `Dockerfile` 整理成固定六步流程並串接文件化流程:(1) 找出專案根目錄與目標 `Dockerfile`、判斷語言/生態與既有建置方式;(2) 在保留建置行為的前提下,把 `Dockerfile` 重整為 **參數處理 → 安裝套件 → 複製檔案 → 執行程序 → 縮小映像檔 → 設定入口** 六步流程(以多階段建置縮小最終映像,可調參數集中於檔首 `ARG`,相依描述先 `COPY` 以利 layer 快取);(3) 最後完整執行 `/jsc-doc:funcs` 處理流程(function 文件、`Dockerfile` 等指令檔逐行註解、重建 README)。當使用者說整理/重構 Dockerfile、把 Dockerfile 排成參數處理→安裝→複製→執行→縮小→入口六步、優化映像檔分層/多階段建置、縮小 image,或提到 image 時觸發。不適用於:Gitea/GitHub action 容器化(用 action-docker)、composite action(用 action-composite)、或專案內沒有也不需要 Dockerfile 的情況。
|
||||||
|
argument-hint: "[--project-dir <專案根目錄>] [--dockerfile <Dockerfile 路徑>] [--yes]"
|
||||||
|
---
|
||||||
|
|
||||||
|
# image — Dockerfile 六步流程整理+文件化
|
||||||
|
|
||||||
|
三階段 skill:先做**前置設定與偵測**(找出專案根目錄、定位目標 `Dockerfile`、判斷語言/生態與既有建置方式),再把 `Dockerfile` **重整為固定六步流程**(參數處理 → 安裝套件 → 複製檔案 → 執行程序 → 縮小映像檔 → 設定入口,並以多階段建置縮小最終映像),最後**完整執行 `/jsc-doc:funcs` 處理流程**替整個專案補文件並重建 README。
|
||||||
|
|
||||||
|
| 階段 | 動作 |
|
||||||
|
| --- | --- |
|
||||||
|
| A. 前置設定與偵測 | 決定專案根目錄 → 定位目標 `Dockerfile`(找不到則詢問,不臆造)→ 讀現有指令、判斷語言/生態、既有 base image 與建置流程 |
|
||||||
|
| B. 整理 Dockerfile 為六步流程 | 在**保留建置行為**前提下,把指令重整/歸位為六步:參數處理 → 安裝套件 → 複製檔案 → 執行程序 → 縮小映像檔 → 設定入口;多階段建置縮小映像;行為不等價處標「需人工確認」並先確認 |
|
||||||
|
| C. 串接 funcs | 對整個專案完整執行 `/jsc-doc:funcs` 流程(function 文件、`Dockerfile` 等指令檔逐行註解、重建 README) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 共用規範(shared plugin,必要前置)
|
||||||
|
|
||||||
|
執行本 skill 前,先以 Skill 工具載入下列共用規範並全程遵守;**任一載入不到(shared plugin 未安裝)時,先詢問使用者是否安裝 shared plugin(`https://gitea.jsc.idv.tw/plugins/shared.git`),使用者不安裝則直接中斷本 skill**,不得只憑下方一行摘要繼續執行:
|
||||||
|
|
||||||
|
- `/jsc-shared:spec-output`:繁體中文(台灣用語)、UTF-8(不含 BOM)無亂碼。
|
||||||
|
- `/jsc-shared:spec-execution`:自動執行原則(必要決策才中斷)、不臆測/需人工確認、不擴及無關檔案。
|
||||||
|
- `/jsc-shared:spec-git-safety`:不破壞既有工作(絕不 `reset --hard`/`clean`)。
|
||||||
|
- `/jsc-shared:spec-dockerfile`:Dockerfile 六步流程、多階段建置、對外契約不動、自我檢查。
|
||||||
|
- `/jsc-shared:spec-doc-funcs-handoff`:最終階段完整執行 `/jsc-doc:funcs` 的標準流程。
|
||||||
|
|
||||||
|
本 skill 特有補充:
|
||||||
|
|
||||||
|
- **一定會中斷詢問的點**:階段 B「重整無法可靠保證建置行為等價」時(破壞性,須先確認),以及階段 C 由 `/jsc-doc:funcs` 自身的「如何實作」詢問。
|
||||||
|
- **保留建置行為**:重整只「重新組織與分層」既有指令,不得擅自改變最終映像的內容、檔案落點、相依版本、暴露的 port、`ENV`、`ENTRYPOINT`/`CMD` 對外契約或建置副作用;多階段建置縮小映像時,runtime 階段必須帶齊執行所需的所有產物,不得遺漏導致容器無法啟動。
|
||||||
|
- **本 skill 只動**:階段 A/B 只動目標 `Dockerfile`(及與其直接相關、為保留行為而必須同步的 `.dockerignore`);其餘檔案僅在階段 C 由 funcs 流程依其規範處理。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 參數
|
||||||
|
|
||||||
|
格式:`[--project-dir <專案根目錄>] [--dockerfile <Dockerfile 路徑>] [--yes]`
|
||||||
|
|
||||||
|
- `--project-dir <專案根目錄>`:專案根目錄。**省略時預設目前工作目錄**。
|
||||||
|
- `--dockerfile <Dockerfile 路徑>`:指定要整理的 `Dockerfile`(相對專案根目錄)。省略時依 A2 自動定位;找到多個時詢問。
|
||||||
|
- `--yes`:盡量不中斷。即使帶此參數,「重整無法保證建置行為等價」與 funcs 的「如何實作」仍會詢問。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 A:前置設定與偵測
|
||||||
|
|
||||||
|
### A1. 決定專案根目錄
|
||||||
|
|
||||||
|
- 帶 `--project-dir` → 採用(展開 `~`)。
|
||||||
|
- 省略 → 用目前工作目錄。
|
||||||
|
|
||||||
|
### A2. 定位目標 Dockerfile
|
||||||
|
|
||||||
|
- 帶 `--dockerfile` → 採用(相對專案根目錄;展開後須存在)。
|
||||||
|
- 省略 → 於專案根目錄與常見位置尋找 `Dockerfile`(含 `Dockerfile.*`、`*/Dockerfile`,排除 `node_modules`/`.git`/`.docs`/`bin`/`obj`/第三方依賴)。
|
||||||
|
- 恰好一個 → 直接採用。
|
||||||
|
- 多個 → 以 `AskUserQuestion` 列出讓使用者選擇要整理哪一個(或逐一整理)。
|
||||||
|
- **找不到** → 回報「專案內找不到 `Dockerfile`」並詢問正確路徑;**不臆造** Dockerfile、不在沒有 Dockerfile 的專案上憑空生成(本 skill 的職責是「整理既有 Dockerfile」,產生全新 action 容器請改用 `/jsc-code:action-docker`)。
|
||||||
|
|
||||||
|
### A3. 讀現有指令並判斷語言/生態與既有建置流程
|
||||||
|
|
||||||
|
讀取目標 `Dockerfile` 全文,盤點並記錄(作為階段 B 重整與 C funcs 的依據):
|
||||||
|
|
||||||
|
- **base image 與階段**:所有 `FROM`(含多階段 `AS <name>`)、目前是單階段或多階段。
|
||||||
|
- **可調參數**:既有 `ARG`/`ENV`(版本、路徑、build flag 等)。
|
||||||
|
- **安裝步驟**:OS 套件(`apt`/`apk`/`yum` 等)、語言相依(`npm ci`/`pip install`/`go mod download`/`dotnet restore`/`mvn`/`gradle` 等)、相依描述檔(`package*.json`/`requirements.txt`/`go.mod`/`*.csproj`/`pom.xml` 等)。
|
||||||
|
- **複製與建置**:`COPY`/`ADD` 來源與落點、`RUN` 建置/編譯/transpile(`npm run build`/`go build`/`dotnet publish`/`mvn package` 等)、`WORKDIR`、`USER`、檔案權限(`chmod`)。
|
||||||
|
- **執行設定**:`EXPOSE`、`ENV`、`VOLUME`、`HEALTHCHECK`、`ENTRYPOINT`/`CMD`(這些是對外契約,重整時不得改變語意)。
|
||||||
|
- **語言/生態**:依 base image 與安裝指令、專案檔分布推斷主要語言(供階段 C funcs 第 0 步沿用,也決定縮小映像時的 runtime 基底選擇)。
|
||||||
|
|
||||||
|
輸出偵測結果(目標 Dockerfile 路徑、單/多階段、base image、推斷語言、既有 `ENTRYPOINT`/`CMD`/`EXPOSE`/`ENV`),再進入階段 B。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 B:整理 Dockerfile 為六步流程
|
||||||
|
|
||||||
|
在**保留建置行為**的前提下,把目標 `Dockerfile` 的指令重整/歸位為 `/jsc-shared:spec-dockerfile` 定義的**固定六步流程**(參數處理 → 安裝套件 → 複製檔案 → 執行程序 → 縮小映像檔 → 設定入口),並採**多階段建置**縮小最終映像;各步要點(ARG 集中檔首、相依描述先 `COPY`、同層清理快取、`COPY --from` 逐項明列、搬移 runtime 需要的 `ENV`/`WORKDIR`/`EXPOSE`/`USER`)依該 spec。
|
||||||
|
|
||||||
|
**重整原則(關鍵)**
|
||||||
|
|
||||||
|
- **語意等價優先**:重排指令前,先確認該調整不改變最終映像內容與建置結果。某些重排會改變行為(例如 `ARG` 的作用範圍跨 `FROM` 會失效、`COPY` 順序影響快取與覆蓋、`RUN` 之間有狀態相依、單階段改多階段時 runtime 缺少 build 期才有的檔案)。**凡無法可靠保證等價的重整,先以 `AskUserQuestion` 向使用者確認**(選項至少含「依建議重整(多階段+六步)」「只在不改變行為前提下做最小重排」「維持原結構只補註解(略過重整,交給階段 C)」「其他」),確認後才覆寫。
|
||||||
|
- **已是多階段** → 將既有各階段對應到六步(build 階段涵蓋 1–4、runtime 階段涵蓋 5–6),補齊缺漏的快取最佳化與清理,不破壞既有 `--from` 依賴。
|
||||||
|
- **單階段改多階段** → 僅在能可靠判斷 runtime 真正需要哪些產物時才做;無法可靠判斷時,**不臆測**,標 `# 需人工確認:runtime 需要的產物清單` 並回報,退回「最小重排+補註解」。
|
||||||
|
- **多階段不適用** → 若該映像本質上無法受益於多階段(例如純資料映像、最終就是要完整建置環境),保留單階段,於步驟 5 以註解說明「此映像不適用多階段縮小」,其餘步驟仍依序歸位。
|
||||||
|
- **對外契約不動**:依 `/jsc-shared:spec-dockerfile`(`ENTRYPOINT`/`CMD`/`EXPOSE`/`ENV`/`VOLUME`/`HEALTHCHECK`/`USER` 語意與原檔一致,只可調整位置與分層)。
|
||||||
|
- **`.dockerignore`**:若為了「複製檔案」步驟的正確性需要排除建置產物/`node_modules`/`.git`,可建立或補強 `.dockerignore`(僅新增排除項,不刪既有),並回報。
|
||||||
|
|
||||||
|
重整骨架(實際指令、base image、語言依階段 A 偵測結果填入;非 Node 專案請換成對應語言的安裝/建置指令與 runtime 基底):
|
||||||
|
|
||||||
|
```Dockerfile
|
||||||
|
# syntax=docker/dockerfile:1
|
||||||
|
|
||||||
|
# 1. 參數處理:可調參數集中於檔首,以 ARG 注入
|
||||||
|
ARG BUILD_IMAGE=<build-base>
|
||||||
|
ARG RUNTIME_IMAGE=<runtime-base-slim>
|
||||||
|
|
||||||
|
# ---- build 階段:安裝相依、複製原始碼、建置產物 ----
|
||||||
|
FROM ${BUILD_IMAGE} AS build
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
# 2. 安裝套件:先帶相依描述以利 layer 快取,再安裝(並清理快取縮小該層)
|
||||||
|
COPY <dependency-manifests> ./
|
||||||
|
RUN <install-deps>
|
||||||
|
|
||||||
|
# 3. 複製檔案:複製其餘原始碼(搭配 .dockerignore)
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
# 4. 執行程序:build / compile / transpile、必要權限設定
|
||||||
|
RUN <build-command>
|
||||||
|
|
||||||
|
# ---- 5. 縮小映像檔:runtime 改用較小基底,只帶執行所需產物 ----
|
||||||
|
FROM ${RUNTIME_IMAGE} AS runtime
|
||||||
|
WORKDIR /app
|
||||||
|
COPY --from=build /app/<artifacts> ./<artifacts>
|
||||||
|
# (搬移 runtime 需要的 ENV / EXPOSE / USER,語意與原檔一致)
|
||||||
|
|
||||||
|
# 6. 設定入口:ENTRYPOINT / CMD 置於最後,語意同原檔
|
||||||
|
ENTRYPOINT [<entrypoint>]
|
||||||
|
```
|
||||||
|
|
||||||
|
- **自我檢查**:依 `/jsc-shared:spec-dockerfile` 的自我檢查清單(跨階段 `ARG` 重新宣告、runtime 帶齊產物、對外契約一致、路徑一致)。
|
||||||
|
- 此檔的「用途/更新日期」開頭註解區塊與逐行註解,於階段 C 由 `/jsc-doc:funcs` 的指令檔流程統一補齊/覆寫為標準格式;本階段先確保**建置行為**正確、六步結構清楚即可。
|
||||||
|
- **建置驗證**:若環境可執行 `docker build`,重整後做一次建置驗證(或至少 `docker build --check`/語法檢查)確認可建置;無法執行時明確說明原因並標註風險(階段 C funcs 第 11 步亦會做語法驗證)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 C:完整執行 /jsc-doc:funcs 處理流程
|
||||||
|
|
||||||
|
Dockerfile 六步整理完成後,以階段 A1 的專案根目錄為目標,依 `/jsc-shared:spec-doc-funcs-handoff` 對**整個專案**完整執行 `/jsc-doc:funcs` 流程(前置可用性檢查、完整流程、由使用者裁示實作方式、重建 README;本次整理的 `Dockerfile` 會被視為部署設定檔補齊標頭與逐行註解)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 總結
|
||||||
|
|
||||||
|
各階段執行後輸出:
|
||||||
|
|
||||||
|
- **階段 A**:專案根目錄、目標 `Dockerfile` 路徑、單/多階段、base image、推斷語言、既有 `ENTRYPOINT`/`CMD`/`EXPOSE`/`ENV`。
|
||||||
|
- **階段 B**:重整摘要(六步歸位結果、是否改為多階段、縮小映像採用的 runtime 基底)、「需人工確認」清單、是否做過建置/語法驗證;並確認對外契約(`ENTRYPOINT`/`CMD`/`EXPOSE`/`ENV` 等)未被破壞。
|
||||||
|
- **階段 C**:funcs 流程的處理結果(文件化的 function 與指令檔、重建的 README)。
|
||||||
|
- 列出本次新增/變更的檔案與其相對路徑,並提醒使用者於提交前確認 `Dockerfile` 可正確建置、容器能正常啟動。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 呼叫方式
|
||||||
|
|
||||||
|
格式:`[--project-dir <專案根目錄>] [--dockerfile <Dockerfile 路徑>] [--yes]` — 全部可省略(專案根目錄預設目前工作目錄;Dockerfile 自動定位,多個時詢問)。
|
||||||
|
|
||||||
|
| 助理 | 呼叫 |
|
||||||
|
| --- | --- |
|
||||||
|
| Claude Code / Antigravity | `/jsc-code:image`,或 `/jsc-code:image --project-dir ~/work/my-app --dockerfile build/Dockerfile` |
|
||||||
|
| Codex | `$image`,或 `$image --dockerfile docker/Dockerfile`,或用 `/skills` 選單 |
|
||||||
|
| OpenCode | 描述需求(如「把這個專案的 Dockerfile 整理成參數處理→安裝套件→複製檔案→執行程序→縮小映像檔→設定入口六步、用多階段建置縮小映像,最後跑 funcs 補文件並重建 README」)自動觸發 |
|
||||||
@@ -0,0 +1,157 @@
|
|||||||
|
---
|
||||||
|
name: issues
|
||||||
|
description: 處理一或多個 Gitea 議題的實作流程:先選擇使用 `tea` 或 Gitea REST API + `GITEA_TOKEN`(已選定則跳過),再確認議題所在專案(已知則跳過)與要處理的議題編號(一或多個);接著讀取議題描述與留言、彙整需求,整理 TODO 列表並依影響範圍由小到大排序,既有 TODO 不足以達成議題需求時補上新 TODO 並附加到議題描述;最後逐項實作 TODO,每完成一項就把進度留言到議題。全程不建立任何草稿檔,中間成果一律用議題描述或留言保存,並盡量以表格與 Mermaid 圖呈現。當使用者說處理議題、實作議題、依議題 TODO 開工、把議題需求整理成 TODO 並逐項完成、議題進度留言,或提到 issues、issue 實作、Gitea 議題處理時觸發。不適用於:把需求拆分成多個新議題(用 issues-analyze)、只同步議題狀態不實作(用 issues-sync)、或與 Gitea 無關的本機 TODO 管理。
|
||||||
|
argument-hint: "[--tool <tea|api>] [--repo <owner/repo>] [--issues <編號,以逗號分隔>] [--host <gitea 主機>] [--yes]"
|
||||||
|
---
|
||||||
|
|
||||||
|
# issues — 彙整議題 TODO 並逐項實作、留言進度
|
||||||
|
|
||||||
|
五階段 skill:先做**工具選擇**(`tea` 或 Gitea REST API + `GITEA_TOKEN`),再**確認議題所在專案**與**要處理的議題編號**,接著**讀取議題並彙整 TODO 列表**(依影響範圍小→大排序,缺漏的 TODO 附加到議題描述),最後**逐項實作 TODO**,每完成一項就把進度**留言到議題**。
|
||||||
|
|
||||||
|
| 階段 | 動作 | 可跳過條件 |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| A. 工具選擇 | 檢查 `tea` / `GITEA_TOKEN` → 詢問使用者要用 `tea` 或 `api` | 使用者已明確選定(`--tool` 或對話中已選)|
|
||||||
|
| B. 確認專案 | 詢問議題所在專案(owner/repo),可用目前 repo 的 origin 當預設選項 | 已知專案(`--repo`、對話已提供、或使用者確認採用 origin)|
|
||||||
|
| C. 選擇議題 | 詢問要處理的議題編號,**一個或多個** | 已提供(`--issues` 或對話中已列出)|
|
||||||
|
| D. 彙整 TODO | 讀議題描述+留言 → 彙整需求 → TODO 依**影響範圍小→大**排序 → 不足以達成需求的缺漏 TODO **附加到議題描述** | — |
|
||||||
|
| E. 逐項實作 | 依排序實作每項 TODO → 每完成一項:勾選議題描述 checkbox + **留言進度到議題** | — |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 絕對準則(不可違反)
|
||||||
|
|
||||||
|
- **不建立任何草稿檔**:不寫 `.docs/`、不寫暫存檔、不用本機檔案傳遞中間結果。需求彙整、TODO 排序、實作進度、驗證結果等所有中間成果,一律留在**對話內容**,並透過 `tea` 或 Gitea API **保存到議題描述或議題留言**。唯一例外是階段 E 在議題範圍內對**目標 repo 原始碼**的正常程式修改。
|
||||||
|
- **盡量使用表格或圖形**:依 `/jsc-shared:spec-output` — 面向使用者的輸出與寫入議題的內容(需求彙整、TODO 列表、進度回報),優先以 Markdown 表格與 Mermaid 圖呈現,忠實反映議題內容、不得杜撰。
|
||||||
|
|
||||||
|
## 共用規範(shared plugin,必要前置)
|
||||||
|
|
||||||
|
執行本 skill 前,先以 Skill 工具載入下列共用規範並全程遵守;**任一載入不到(shared plugin 未安裝)時,先詢問使用者是否安裝 shared plugin(`https://gitea.jsc.idv.tw/plugins/shared.git`),使用者不安裝則直接中斷本 skill**,不得只憑下方一行摘要繼續執行:
|
||||||
|
|
||||||
|
- `/jsc-shared:spec-output`:繁體中文(台灣用語)、UTF-8(不含 BOM)無亂碼、API body 以 UTF-8 JSON 檔帶入且換行為實際換行。
|
||||||
|
- `/jsc-shared:spec-execution`:自動執行原則(必要決策才中斷)、不臆測/需人工確認、已知資訊跳過詢問。
|
||||||
|
- `/jsc-shared:spec-gitea`:tea/API 工具選擇與檢查、`GITEA_TOKEN` 機密保護(不 echo、遮蔽)、不依賴 `jq`、API 分頁完整讀取。
|
||||||
|
|
||||||
|
本 skill 特有補充:
|
||||||
|
|
||||||
|
- **必要決策**(會中斷詢問):工具皆不可用、專案不明、議題編號缺失、TODO 與需求衝突需人工裁示、實作失敗需使用者決策。
|
||||||
|
- 階段 A/B/C 的詢問在「可跳過條件」成立時**必須跳過**,不要重複確認已知資訊。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 參數
|
||||||
|
|
||||||
|
格式:`[--tool <tea|api>] [--repo <owner/repo>] [--issues <編號,以逗號分隔>] [--host <gitea 主機>] [--yes]`
|
||||||
|
|
||||||
|
- `--tool <tea|api>`:指定工具,**帶此參數時跳過階段 A 的詢問**(仍需驗證該工具可用)。
|
||||||
|
- `--repo <owner/repo>`:議題所在專案,**帶此參數時跳過階段 B 的詢問**。
|
||||||
|
- `--issues <編號,以逗號分隔>`:要處理的議題編號,可一個或多個(例 `--issues 12` 或 `--issues 12,15,18`),**帶此參數時跳過階段 C 的詢問**。
|
||||||
|
- `--host <gitea 主機>`:gitea 主機(如 `gitea.jsc.idv.tw`);省略時依 `--repo` 的 URL、目前 repo 的 origin 或 `tea login` 對應 host 決定,無法決定時詢問。
|
||||||
|
- `--yes`:全自動;即使未帶此參數,也依「自動執行原則」盡量不中斷。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 A:工具選擇(已選定則跳過)
|
||||||
|
|
||||||
|
**若使用者已透過 `--tool` 或對話明確選定工具,跳過詢問**,只做該工具的可用性驗證。
|
||||||
|
|
||||||
|
依 `/jsc-shared:spec-gitea` 的工具選擇流程執行:檢查 `tea`(`command -v tea`、`tea login list`)與 `GITEA_TOKEN`(只輸出「已設定/未設定」)→ 以表格呈現檢查結果後詢問使用者要用 `tea` 或 `api` → 兩種方式都不可用則回報並停止(不要請使用者把 token 貼進對話)。
|
||||||
|
|
||||||
|
## 階段 B:確認議題所在專案(已知則跳過)
|
||||||
|
|
||||||
|
**若已透過 `--repo`、對話內容或先前階段確知專案,跳過詢問。**
|
||||||
|
|
||||||
|
1. 若目前工作目錄是 git repo,解析 `git remote get-url origin` 取得 host/owner/repo 作為**預設選項**提供給使用者。
|
||||||
|
2. 詢問使用者議題所在專案(owner/repo 或 repo URL);使用者只給名稱時,確認 host/owner 補齊完整座標。
|
||||||
|
3. 驗證專案可讀:
|
||||||
|
- `tea`:`tea repos <owner>/<repo>` 或 `tea issues list --repo <owner>/<repo> --limit 1`
|
||||||
|
- `api`:`GET https://<host>/api/v1/repos/<owner>/<repo>`
|
||||||
|
4. 確認本機是否已 clone 該 repo(實作階段需要);找不到本機 repo 時詢問路徑或是否需要 clone,不臆測位置。
|
||||||
|
|
||||||
|
## 階段 C:選擇要處理的議題編號(一個或多個)
|
||||||
|
|
||||||
|
**若已透過 `--issues` 或對話提供編號,跳過詢問。**
|
||||||
|
|
||||||
|
1. 先列出該專案開啟中的議題供使用者參考(編號、標題、標籤、里程碑),以表格呈現:
|
||||||
|
- `tea`:`tea issues list --repo <owner>/<repo> --state open --output csv --fields index,title,labels,milestone`
|
||||||
|
- `api`:`GET {base}/issues?state=open&type=issues`(有分頁必須完整分頁讀取)
|
||||||
|
2. 詢問使用者要處理哪些議題編號,**接受一個或多個**。
|
||||||
|
3. 逐一驗證每個編號存在且為 issue(非 pull request);不存在或已關閉的編號回報並請使用者確認是否仍要處理。
|
||||||
|
|
||||||
|
## 階段 D:彙整需求與 TODO 列表(依影響範圍小→大排序)
|
||||||
|
|
||||||
|
對每一個選定議題執行:
|
||||||
|
|
||||||
|
### D1. 讀取議題完整內容
|
||||||
|
|
||||||
|
- 讀取 `title`、`body`、`state`、`labels`、`milestone`、`assignees` 與**所有留言**:
|
||||||
|
- `tea`:`tea issues <index> --repo <owner>/<repo> --comments`
|
||||||
|
- `api`:`GET {base}/issues/{index}` 與 `GET {base}/issues/{index}/comments`
|
||||||
|
- 留言中若有需求補充、變更或取消,必須納入需求彙整,並以最新留言為準。
|
||||||
|
|
||||||
|
### D2. 彙整需求並盤點既有 TODO
|
||||||
|
|
||||||
|
- 把議題描述與留言整理成**需求彙整**:目標、驗收條件、限制條件;只做歸納,不編造議題未提及的需求,不確定處標註「需人工確認」。
|
||||||
|
- 盤點議題描述中既有的 Markdown checklist(`- [ ]` / `- [x]`)作為既有 TODO;已勾選項目視為已完成,不重做。
|
||||||
|
|
||||||
|
### D3. 產生排序後的 TODO 列表
|
||||||
|
|
||||||
|
- 每項 TODO 必須**可執行、可驗收**,並評估其**影響範圍**(預計修改的檔案/模組數與波及面):
|
||||||
|
|
||||||
|
| 影響範圍 | 定義(參考) |
|
||||||
|
| --- | --- |
|
||||||
|
| XS | 單一檔案內的局部修改(文案、設定值、小修正) |
|
||||||
|
| S | 單一檔案或單一函式的邏輯調整 |
|
||||||
|
| M | 同一模組內跨多檔案的修改 |
|
||||||
|
| L | 跨模組修改或介面/契約變更 |
|
||||||
|
| XL | 跨專案、資料結構或流程性的大改動 |
|
||||||
|
|
||||||
|
- **依影響範圍由小到大排序**(XS → XL);範圍相同時,前置依賴在前。
|
||||||
|
- **勾稽需求覆蓋度**:逐條比對需求彙整與 TODO 列表;若既有 TODO **不足以達成議題描述與需求**,補上缺漏的 TODO(標註「新增」)。
|
||||||
|
- 有助理解時,在留言或描述中加入 Mermaid 流程圖呈現 TODO 之間的依賴與執行順序。
|
||||||
|
|
||||||
|
### D4. 缺漏 TODO 附加到議題描述
|
||||||
|
|
||||||
|
- 若 D3 有新增 TODO,用 `tea` 或 API **更新議題描述**:保留原描述內容,於既有 `## TODO` 區塊補上新項目;沒有該區塊時在描述最後加上 `## TODO`:
|
||||||
|
- `tea`:`tea issues edit <index> --repo <owner>/<repo> --description <更新後全文>`(tea 版本不支援時改用 API)
|
||||||
|
- `api`:`PATCH {base}/issues/{index}`,body 以 UTF-8 JSON 檔帶入 `{"body": "..."}`
|
||||||
|
- 更新前先向使用者以表格摘要「新增了哪些 TODO、為什麼需要」;帶 `--yes` 時直接執行並回報。
|
||||||
|
- 沒有新增 TODO 時不改動議題描述。
|
||||||
|
|
||||||
|
## 階段 E:逐項實作 TODO,每完成一項留言到議題
|
||||||
|
|
||||||
|
依 D3 排序(多議題時先完成一個議題的所有 TODO,再進入下一個議題;有跨議題依賴時先處理被依賴者)逐項執行:
|
||||||
|
|
||||||
|
1. **實作**:在本機 repo 依 TODO 內容實作,只修改該 TODO 必要範圍;發現需要擴大範圍或牽動其他 TODO 時,先停止並詢問使用者。
|
||||||
|
2. **驗證**:執行適合專案的建置/測試/驗證;失敗時修正到通過,無法通過則記錄原因並在留言中標註「待人工處理」。
|
||||||
|
3. **更新議題描述**:把該 TODO 的 checkbox 由 `- [ ]` 勾成 `- [x]`(同 D4 的更新方式)。
|
||||||
|
4. **留言進度到議題**(每完成一項就留言,不可累積到最後一次補):
|
||||||
|
- `tea`:`tea comment <index> --repo <owner>/<repo> <內容>`
|
||||||
|
- `api`:`POST {base}/issues/{index}/comments`,body 以 UTF-8 JSON 檔帶入
|
||||||
|
- 留言內容以表格呈現:本項 TODO、影響範圍、主要變更(檔案/模組)、驗證方式與結果、整體進度(`已完成 n/總數 m`);有助理解時附 Mermaid 圖。
|
||||||
|
5. 全部 TODO 完成後,對每個議題留下**總結留言**:TODO 完成統計表、變更檔案清單、驗證總結、待人工處理項目(若有)。
|
||||||
|
|
||||||
|
> 本 skill 範圍到「實作+留言」為止;是否 commit、push、開 PR 或關閉議題**不在本 skill 自動範圍**,由使用者另行指示(可搭配 `review-resolve` 的分類提交與 PR 流程)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 總結
|
||||||
|
|
||||||
|
各階段執行後輸出:
|
||||||
|
|
||||||
|
- **階段 A**:選定工具(`tea` 或 `api`)、可用性檢查結果(token 只顯示已設定/未設定)、是否因已選定而跳過詢問。
|
||||||
|
- **階段 B**:議題所在專案(host/owner/repo)、本機 repo 位置、是否因已知而跳過詢問。
|
||||||
|
- **階段 C**:處理的議題編號清單(含標題),是否因已提供而跳過詢問。
|
||||||
|
- **階段 D**:每個議題的需求彙整重點、TODO 列表(含影響範圍排序)、新增了幾項 TODO 並是否已附加到議題描述。
|
||||||
|
- **階段 E**:每項 TODO 的完成狀態與留言連結(或編號)、驗證結果、待人工處理項目;提醒後續可自行決定 commit/PR/關閉議題。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 呼叫方式
|
||||||
|
|
||||||
|
格式:`[--tool <tea|api>] [--repo <owner/repo>] [--issues <編號,以逗號分隔>] [--host <gitea 主機>] [--yes]` — 全部可省略;省略時依階段 A/B/C 詢問(已知資訊一律跳過詢問)。token 一律由環境變數 `GITEA_TOKEN` 提供。
|
||||||
|
|
||||||
|
| 助理 | 呼叫 |
|
||||||
|
| --- | --- |
|
||||||
|
| Claude Code / Antigravity | `/jsc-code:issues`,或 `/jsc-code:issues --tool api --repo plugins/code --issues 12,15 --yes` |
|
||||||
|
| Codex | `$issues`,或 `$issues --tool tea --repo plugins/code --issues 12`,或用 `/skills` 選單 |
|
||||||
|
| OpenCode | 描述需求(如「用 GITEA_TOKEN 讀 plugins/code 的 12、15 號議題,整理需求成 TODO 依影響範圍小到大排序、缺的補進議題描述,然後逐項實作、每完成一項留言進度」)自動觸發 |
|
||||||
@@ -0,0 +1,162 @@
|
|||||||
|
---
|
||||||
|
name: nuget
|
||||||
|
description: 將 C# / .NET 專案的 NuGet 套件更新到最新可用版本。當使用者要求更新 NuGet、升級 PackageReference、清理重複套件參考、檢查專案參考中的重複 NuGet、或逐包更新並確認 build 時觸發。流程會依專案分組列出套件,檢查 ProjectReference 上層專案是否已引用相同套件並移除可安全移除的重複參考,接著逐一更新套件版本;每更新或移除一個套件都必須 restore/build 驗證。若更新到最新版本後編譯失敗,改由目前版本之後的最小可用版本逐版升級,直到遇到第一個編譯失敗版本,保留最後一個可編譯版本。不適用於:非 .NET 專案、只想查詢套件清單不更新、或只要人工建議不修改檔案。
|
||||||
|
argument-hint: "[<solution-or-project>] [--include-prerelease] [--no-dedupe] [--build <command>] [--yes]"
|
||||||
|
---
|
||||||
|
|
||||||
|
# nuget — 更新 C# 專案 NuGet 套件
|
||||||
|
|
||||||
|
把 C# / .NET repo 內的 NuGet 套件依專案盤點、清理可安全移除的重複參考,然後逐一更新到最新可用版本。每個套件異動後都要驗證專案可以正常編譯;若最新版本失敗,改從目前版本之後的最小可用版本逐版升級,直到第一個編譯失敗版本為止,保留最後一個可編譯版本並記錄失敗點。
|
||||||
|
|
||||||
|
## 共用規範(shared plugin,必要前置)
|
||||||
|
|
||||||
|
執行本 skill 前,先以 Skill 工具載入下列共用規範並全程遵守;**任一載入不到(shared plugin 未安裝)時,先詢問使用者是否安裝 shared plugin(`https://gitea.jsc.idv.tw/plugins/shared.git`),使用者不安裝則直接中斷本 skill**,不得只憑下方一行摘要繼續執行:
|
||||||
|
|
||||||
|
- `/jsc-shared:spec-output`:繁體中文(台灣用語)、UTF-8(不含 BOM)無亂碼(套件 id、檔名、指令、版本號保留原文)。
|
||||||
|
- `/jsc-shared:spec-execution`:自動執行原則(必要決策才中斷)、不臆測/需人工確認。
|
||||||
|
|
||||||
|
## 輸出規範(本 skill 特有)
|
||||||
|
|
||||||
|
- 修改前先輸出簡短執行計畫;除非使用者要求確認、遇到多個 solution 無法判斷、或編譯失敗需要取捨,否則依計畫執行。
|
||||||
|
- 每個套件都要留下結果:已更新 / 已降階到可編譯版本 / 已略過 / 已回復 / 已移除重複參考,以及對應版本與驗證指令。
|
||||||
|
- 不主動 commit、push 或開 PR;使用者明確要求時才做。
|
||||||
|
- **遇到 `JSC` 開頭的套件(套件 id 前綴為 `JSC`)時,必須先通知使用者並詢問是否要繼續處理該套件,取得明確同意後才可動作(更新版本或移除重複參考)。此確認為強制項,不得被 `--yes` 略過。使用者若拒絕,將該套件記為「已略過(JSC 套件,使用者未同意)」並繼續處理其他套件。**
|
||||||
|
|
||||||
|
## 參數
|
||||||
|
|
||||||
|
`[<solution-or-project>] [--include-prerelease] [--no-dedupe] [--build <command>] [--yes]`
|
||||||
|
|
||||||
|
- `<solution-or-project>`:`.sln`、`.slnx` 或 `.csproj` 路徑。省略時自動搜尋;若找到多個 solution 且無法判斷主專案,必須詢問。
|
||||||
|
- `--include-prerelease`:更新時允許 prerelease 版本;未指定時只更新 stable 版本。
|
||||||
|
- `--no-dedupe`:略過 ProjectReference 重複 PackageReference 清理,只更新版本。
|
||||||
|
- `--build <command>`:覆寫驗證指令,例如 `dotnet build My.sln -c Release`。未指定時用 `dotnet build <solution-or-project> --no-restore`。
|
||||||
|
- `--yes`:可略過一般確認,但仍不可忽略多 solution 選擇、無法安全清理重複參考、編譯失敗的必要決策、或 `JSC` 開頭套件的繼續確認。
|
||||||
|
|
||||||
|
## 執行流程
|
||||||
|
|
||||||
|
### 1. 探測專案與工具
|
||||||
|
|
||||||
|
1. 確認目前在 repo 根目錄或可找到 git root。
|
||||||
|
2. 檢查工具:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
dotnet --info
|
||||||
|
dotnet --list-sdks
|
||||||
|
```
|
||||||
|
|
||||||
|
3. 找出目標:
|
||||||
|
- 參數有指定 `.sln` / `.slnx` / `.csproj` → 使用該路徑。
|
||||||
|
- 未指定 → 依序搜尋 `.slnx`、`.sln`、`.csproj`。
|
||||||
|
- 多個 solution 且無明顯唯一主檔 → 詢問使用者選擇,不可猜測。
|
||||||
|
4. 先執行 baseline 驗證:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
dotnet restore <目標>
|
||||||
|
dotnet build <目標> --no-restore
|
||||||
|
```
|
||||||
|
|
||||||
|
baseline build 失敗時停止,回報現況;不要在不可編譯的基準上升級套件。
|
||||||
|
|
||||||
|
### 2. 依專案分組列出 NuGet 套件
|
||||||
|
|
||||||
|
1. 找出目標涵蓋的所有 `.csproj`:
|
||||||
|
- solution:可用 `dotnet sln <solution> list`,必要時解析輸出中的 `.csproj`。
|
||||||
|
- 單一 project:只處理該 project 與其 ProjectReference 圖。
|
||||||
|
2. 對每個專案列出 direct 套件:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
dotnet list <project.csproj> package --outdated
|
||||||
|
dotnet list <project.csproj> package --include-transitive
|
||||||
|
```
|
||||||
|
|
||||||
|
3. 讀取 `.csproj`、`Directory.Packages.props`、`Directory.Build.props`,判斷是否使用 Central Package Management(`ManagePackageVersionsCentrally` / `PackageVersion`)。
|
||||||
|
4. 產出「依專案分組」清單:
|
||||||
|
|
||||||
|
| 專案 | 套件 | 目前版本 | 最新版本 | 參考來源 | 備註 |
|
||||||
|
| --- | --- | --- | --- | --- | --- |
|
||||||
|
|
||||||
|
`參考來源` 標註 `PackageReference`、`Directory.Packages.props`、`transitive` 或 `ProjectReference`。
|
||||||
|
|
||||||
|
### 3. 檢查 ProjectReference 重複套件
|
||||||
|
|
||||||
|
> 這裡的「上層專案」指目前專案透過 `ProjectReference` 直接或間接參考到的專案;若該被參考專案已 direct reference 同一個 NuGet 套件,且該套件會透過專案參考傳遞,當前專案通常不需要重複 direct reference。
|
||||||
|
|
||||||
|
1. 建立 ProjectReference graph:
|
||||||
|
- 讀每個 `.csproj` 的 `<ProjectReference Include="...">`。
|
||||||
|
- 正規化路徑,建立「目前專案 → 被參考專案」的 direct / transitive 關係。
|
||||||
|
2. 比對 direct PackageReference:
|
||||||
|
- 若目前專案與其 direct/transitive ProjectReference 上層專案有相同套件 id,列為重複候選。
|
||||||
|
- 若目前專案的套件參考含 `PrivateAssets="all"`、`IncludeAssets` / `ExcludeAssets` 特殊設定、analyzers/build/source generators、或版本刻意高於上層專案,先列為「需人工確認」,不要自動移除。
|
||||||
|
- 若上層專案的參考含 `PrivateAssets="all"` 或不會傳遞必要 assets,不可視為可替代。
|
||||||
|
3. 對可安全移除的重複 direct reference 逐一處理:
|
||||||
|
- **若該套件 id 為 `JSC` 開頭,先通知使用者並詢問是否繼續移除,取得同意才處理;未同意則記為「已略過(JSC 套件,使用者未同意)」。此確認不得被 `--yes` 略過。**
|
||||||
|
- 先記錄目前檔案狀態與套件版本。
|
||||||
|
- 移除當前專案的重複 `PackageReference`;若使用 Central Package Management,只有在沒有任何專案仍需要該 `PackageVersion` 時才移除中央版本項。
|
||||||
|
- 執行:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
dotnet restore <目標>
|
||||||
|
dotnet build <目標> --no-restore
|
||||||
|
```
|
||||||
|
|
||||||
|
- build 成功 → 保留移除。
|
||||||
|
- build 失敗 → 回復該移除,重新 restore/build 確認回復後可編譯,並記錄失敗原因。
|
||||||
|
|
||||||
|
### 4. 逐一更新套件版本
|
||||||
|
|
||||||
|
1. 排除不應更新的項目:
|
||||||
|
- transitive-only 套件不直接更新;更新提供它的 direct 套件。
|
||||||
|
- 明確 pin 住版本且註解或 props 顯示有相容性原因者,先列入「需人工確認」。
|
||||||
|
- `PrivateAssets="all"` 的 analyzer / generator / build tooling 可更新,但要特別注意 build 驗證結果。
|
||||||
|
- **`JSC` 開頭的套件:在更新版本前,必須先通知使用者「即將處理 JSC 套件 `<PackageId>`」並詢問是否繼續,取得同意才更新;未同意則記為「已略過(JSC 套件,使用者未同意)」。此確認不得被 `--yes` 略過。**
|
||||||
|
2. 逐一更新 direct 套件:
|
||||||
|
- 一次只更新一個套件 id。
|
||||||
|
- 若多個專案引用同一套件,先判斷是否使用 Central Package Management:
|
||||||
|
- CPM:更新對應 `Directory.Packages.props` 的單一 `PackageVersion`。
|
||||||
|
- 非 CPM:依專案逐一更新該套件。
|
||||||
|
- 優先使用 `dotnet add <project> package <PackageId>` 讓 NuGet 選擇最新相容 stable 版本;若 `dotnet list package --outdated` 已提供最新版本,也可用 `--version <latest>` 明確更新。
|
||||||
|
- 指定 `--include-prerelease` 時,查詢與更新都允許 prerelease;未指定時不得升到 prerelease。
|
||||||
|
3. 每更新一個套件後立即驗證:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
dotnet restore <目標>
|
||||||
|
dotnet build <目標> --no-restore
|
||||||
|
```
|
||||||
|
|
||||||
|
若使用者提供 `--build <command>`,以該命令取代 build 步驟,但 restore 仍需執行。
|
||||||
|
4. 驗證結果:
|
||||||
|
- 成功:記錄 `PackageId oldVersion -> newVersion`,保留變更。
|
||||||
|
- 最新版本失敗:先回復最新版本異動與 lock file 變更,確認回到可編譯狀態;接著查詢該套件「目前版本之後、最新版本之前或等於最新版本」的所有可用版本,由最低版本開始逐一升級並每版 restore/build。遇到成功就暫時保留並繼續下一版;遇到第一個失敗版本就停止此套件升級、回復到上一個成功版本,記錄為「已降階到可編譯版本」。如果第一個候選版本就失敗,回復到原版本並記錄為「已回復」。
|
||||||
|
- 查詢可用版本時優先使用目前專案既有 feed 設定(`nuget.config`);可用 `dotnet package search`、`nuget list`、NuGet v3 API 或專案環境可用的等價工具。不得改用未設定的公開 feed 造成私有套件版本判斷錯誤。
|
||||||
|
- 因相依套件版本衝突導致失敗:可嘗試更新同一 dependency chain 中的必要 direct 套件,但仍必須一次一包、每包驗證。
|
||||||
|
|
||||||
|
### 5. 特殊檔案與版本管理
|
||||||
|
|
||||||
|
- `packages.lock.json` 存在時,更新套件後允許 lock file 跟著變更;回復失敗更新時也要回復 lock file。
|
||||||
|
- `nuget.config` 有私有 feed 時,不輸出 credential;錯誤訊息若含 token / password 必須遮蔽。
|
||||||
|
- `packages.config` 專案不套用 `dotnet add package` 流程;先回報這是舊格式,使用 `nuget.exe update` 或請使用者確認遷移策略。
|
||||||
|
- 多 target framework 專案以完整目標 build 為準,不只 build 單一 framework。
|
||||||
|
|
||||||
|
### 6. 最終總結
|
||||||
|
|
||||||
|
完成後輸出:
|
||||||
|
|
||||||
|
| 類別 | 套件 / 專案 | 結果 |
|
||||||
|
| --- | --- | --- |
|
||||||
|
|
||||||
|
至少包含:
|
||||||
|
|
||||||
|
- 重複 PackageReference:移除幾筆、回復幾筆、需人工確認幾筆。
|
||||||
|
- NuGet 更新:成功幾筆、已是最新幾筆、降階到可編譯版本幾筆、回復幾筆、略過幾筆。
|
||||||
|
- 最後一次成功驗證的指令。
|
||||||
|
- 尚待人工處理的套件與原因。
|
||||||
|
|
||||||
|
若所有變更後最終 build 成功,明確寫「最終編譯驗證成功」。若有套件因最新版本失敗而降階或回復,說明目前工作區保留的是已通過 build 的變更集合,並列出失敗版本與最後成功版本。
|
||||||
|
|
||||||
|
## 呼叫方式
|
||||||
|
|
||||||
|
| 助理 | 呼叫 |
|
||||||
|
| --- | --- |
|
||||||
|
| Claude Code / Antigravity | `/jsc-code:nuget`,或 `/jsc-code:nuget MySolution.sln --include-prerelease` |
|
||||||
|
| Codex | `$nuget`,或 `$nuget src/App/App.csproj --build "dotnet build App.sln -c Release"` |
|
||||||
|
| OpenCode | 描述需求(如「把這個 .NET solution 的 NuGet 都更新到最新,先清掉 ProjectReference 已提供的重複套件,每更新一包就 build」)自動觸發 |
|
||||||
@@ -0,0 +1,553 @@
|
|||||||
|
---
|
||||||
|
name: review-resolve
|
||||||
|
description: 解決新版 AI Code Review 的 findings——一律讀取專案內 `.gitea/ai-review/findings/` 目錄下的 wrapper 物件 JSON(含 `findings`/`excluded` 陣列、中文 severity)與 `findings.json`,並可額外用 `--issue`(無/單選/多選/全部)從 Gitea 議題(建問題模式)解析嚴重問題留言為 findings,兩來源合併去重後逐條解決;先同步 git(fetch → 檢查目前分支的遠端分支是否存在;存在則留在目前分支 pull 更新,不存在則切換到 develop/master 後 pull 更新;只有來源分支與 PR 目標分支相同時才建立新的工作分支;必要時嘗試解衝突),再依嚴重度(嚴重/警告/建議)逐條修復;可判斷為誤報者寫入 `.gitea/ai-review/exclusions.json`,已解決或已登記為誤報的 finding 逐檔就地自來源 wrapper 移除;處理過的議題於留言進度、把只來自議題的待人工處理問題寫回 findings 目錄後關閉;接著可將工作區變更依 conventional commit 類型分類提交、push 當前分支,並透過 Gitea API 對指定目標分支開 PR。當使用者說解決 findings、處理 AI review 問題、依議題編號修 code review 問題、修掉 `.gitea/ai-review` 問題、依嚴重度修復後分類提交,或要分類 commit 並 push/開 PR 時觸發。不適用於:產生 findings、單純 code review 不修改、只保存裁決紀錄,或只要不分類的單一 commit。
|
||||||
|
argument-hint: "[--issue <編號|編號清單|all>] [--findings <findings 檔或目錄路徑>] [--target <目標分支>] [--pr-desc <full|simple|自訂文字>] [--no-commit] [--no-pr] [--yes]"
|
||||||
|
---
|
||||||
|
|
||||||
|
# review-resolve — 解決 AI review findings、分類提交、push 並開 PR
|
||||||
|
|
||||||
|
五階段 skill:先執行 **git 同步**(`git fetch` → 確認目前分支的遠端分支是否存在;存在則留在目前分支 `git pull` 更新,不存在則切換到 `develop`,再退而 `master` 後 `git pull` 更新;只有來源分支與 PR 目標分支相同時才建立新的工作分支;必要時告知並嘗試解衝突),再**蒐集問題來源**——**一律讀** `.gitea/ai-review/findings/` 目錄下的 wrapper 物件 JSON(取其 `findings` 陣列)與 `findings.json`,並依 `--issue`(無/單選/多選/全部)**額外**從 Gitea 議題留言解析嚴重問題,兩來源**合併去重**後逐條處理;成立問題修復後自來源 wrapper 逐檔就地移除,可判斷為誤報者寫入 `.gitea/ai-review/exclusions.json` 後也可移除(處理過的議題於留言進度、把只來自議題的待人工處理問題寫回 findings 目錄後關閉),接著**必須盤點並處理工作區的所有變更**,再依 conventional commit 類型分門別類 commit,然後 **push 當前分支**,最後**透過 Gitea API 發 PR**。
|
||||||
|
|
||||||
|
| 階段 | 動作 |
|
||||||
|
| --- | --- |
|
||||||
|
| A. Git 同步 | `git fetch` → 當前分支不在遠端則切換 develop(再退而 master)→ `git pull`/必要時解衝突 → 只有來源分支與 PR 目標分支相同時才建立新工作分支 |
|
||||||
|
| B. 解決問題 | 一律讀 `.gitea/ai-review/findings/*.json`+`findings.json`(wrapper,取 `findings`),依 `--issue`(無/單選/多選/全部)加讀議題留言 → 合併去重 → 依等級 🔴嚴重→🟠警告→🔵建議 逐條修復或判斷誤報 → 已解決者逐檔就地自來源 wrapper 移除,誤報寫入 `exclusions.json`;處理過的議題回寫(留言+只來自議題的待人工寫回 findings 後關閉);**無待處理問題則跳到階段 D** |
|
||||||
|
| C. 分類提交 | 必須分析並涵蓋工作區所有變更(已修改/新增/刪除/改名,含已暫存與未暫存、未追蹤檔、findings/exclusions 更新)→ 依 feat/fix/docs/style/refactor/perf/test/chore/revert 分組 → 各組一個 commit |
|
||||||
|
| D. Push 當前分支 | 認證管理器 → 失敗改 token → 再失敗詢問使用者;**無 commit 可 push 則跳到階段 E** |
|
||||||
|
| E. 發出 PR | 確定目標分支(不明必問)→ 選 PR 描述(完整/簡單/自訂)→ token 呼叫 Gitea API 建 PR → 通知並清除內文 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 共用規範(shared plugin,必要前置)
|
||||||
|
|
||||||
|
執行本 skill 前,先以 Skill 工具載入下列共用規範並全程遵守;**任一載入不到(shared plugin 未安裝)時,先詢問使用者是否安裝 shared plugin(`https://gitea.jsc.idv.tw/plugins/shared.git`),使用者不安裝則直接中斷本 skill**,不得只憑下方一行摘要繼續執行:
|
||||||
|
|
||||||
|
- `/jsc-shared:spec-output`:繁體中文(台灣用語)、UTF-8(不含 BOM)無亂碼(含 commit 訊息、PR 標題/描述、寫檔/API body 實作要點與送出前自我檢查)。
|
||||||
|
- `/jsc-shared:spec-execution`:自動執行原則(必要決策才中斷)、不臆測/需人工確認。
|
||||||
|
- `/jsc-shared:spec-gitea`:`GITEA_TOKEN` 機密保護(不 echo、遮蔽 `***`)、API body 以 UTF-8 JSON 檔帶入。
|
||||||
|
- `/jsc-shared:spec-git-safety`:不破壞既有工作、develop → master 後備、保守解衝突、新分支不覆蓋既有分支。
|
||||||
|
|
||||||
|
本 skill 特有補充:
|
||||||
|
|
||||||
|
- **必要決策**(會中斷詢問):目標分支缺失、pull 策略不明、無法安全解衝突、需人工判斷的設計取捨、push 憑證皆失敗。
|
||||||
|
- 涵蓋範圍:更新後的 `findings/*.json`(wrapper)/ `exclusions.json`、議題留言、commit 訊息、PR 標題/描述、終端訊息,與等級 emoji 🔴🟠🔵。
|
||||||
|
- 階段 E 完成後依規範清除對話內文(見 E6)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 參數
|
||||||
|
|
||||||
|
格式:`[--issue <編號|編號清單|all>] [--findings <路徑>] [--target <目標分支>] [--pr-desc <full|simple|自訂文字>] [--no-commit] [--no-pr] [--yes]`
|
||||||
|
|
||||||
|
- `--issue <無 / 編號 / 編號清單 / all>`:**額外**從 Gitea 議題(對應 code-review 建問題模式)撈問題,支援四種——**無**(省略此參數,不讀議題)、**單選**(`--issue 12`)、**多選**(`--issue 12,15,20` 逗號分隔)、**全部**(`--issue all`,讀 repo 內所有 open 議題)。帶此參數時走 B1b 解析議題嚴重問題留言為 findings;修復後於 B6 對每個處理過的議題留言進度、把「只來自議題」的待人工處理問題寫回 `findings/` 目錄後關閉該議題。需要 `GITEA_TOKEN` 與可解析的 `origin` repo 座標。**注意:不論有無此參數,findings 檔一律照讀(見 `--findings`),議題只是額外來源。**
|
||||||
|
- `--findings <路徑>`:findings 檔來源路徑。**不論是否帶 `--issue`,都一律讀取**;省略時預設讀目錄 `.gitea/ai-review/findings/` 下所有 `*.json` **與**(若存在)單一檔 `.gitea/ai-review/findings.json`(每個檔為新版 wrapper 物件,取其 `findings` 陣列)(相對於工作目錄根)。指定路徑時:目錄則讀該目錄所有 `*.json`;單一檔則讀該檔(同為 wrapper 物件)。findings 檔與 `--issue` 議題的問題會在 B1c 合併去重後一起處理。
|
||||||
|
- `--target <目標分支>`:PR 的目標分支。**省略時必須詢問使用者,不可猜測**;若需要避免把同名來源分支誤推到目標分支,可能會在階段 D 先詢問並於階段 E 沿用。
|
||||||
|
- `--pr-desc <full|simple|自訂文字>`:PR 描述形式。`full`=完整版(重新分析 diff 總結)、`simple`=簡單版(逐條列 commit 訊息)、或直接給自訂文字;省略時預設 `full`,不要為描述形式中斷詢問。
|
||||||
|
- `--no-commit`:只做階段 A/B(git 同步 + 修復 + 更新 findings/exclusions),**不**執行階段 C/D/E(不提交、不推送、不開 PR)。
|
||||||
|
- `--no-pr`:執行到階段 D(push)為止,**不**開 PR(階段 E 略過)。
|
||||||
|
- `--yes`:明確要求全自動執行(修復、更新 findings/exclusions、commit、push、開 PR 一氣呵成);即使未帶此參數,也依「自動執行原則」盡量不中斷,只有必要決策才詢問。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 A:Git 同步
|
||||||
|
|
||||||
|
### A1. 檢查同步前狀態
|
||||||
|
|
||||||
|
執行同步前先盤點目前分支與工作區狀態:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git rev-parse --abbrev-ref HEAD
|
||||||
|
git status --porcelain
|
||||||
|
```
|
||||||
|
|
||||||
|
- **若工作區已有未提交變更**:先告知使用者同步可能需要 merge / rebase 並可能與本地變更衝突;除非使用者要求先確認或目前狀態明顯容易覆蓋未提交工作,否則繼續同步。
|
||||||
|
- **若目前不在一般分支上**(例如 detached HEAD):回報狀態並停止,請使用者切到要處理的分支後再執行。
|
||||||
|
|
||||||
|
### A2. Fetch 遠端更新
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git fetch --all --prune
|
||||||
|
```
|
||||||
|
|
||||||
|
- fetch 失敗時回報錯誤並停止,不進入 findings 修復。
|
||||||
|
- 若錯誤訊息可能含 credential / token,輸出前必須遮蔽。
|
||||||
|
|
||||||
|
### A3. 確認當前分支存在於遠端,必要時切換(develop → master)
|
||||||
|
|
||||||
|
fetch 後,確認當前分支在遠端是否有對應分支:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
current_branch="$(git rev-parse --abbrev-ref HEAD)"
|
||||||
|
git rev-parse --verify --quiet "origin/${current_branch}"
|
||||||
|
```
|
||||||
|
|
||||||
|
- **`origin/<current_branch>` 存在** → 維持當前分支,直接進入 A4 更新到最新;不要只因目前分支有遠端同名分支就建立新工作分支,後續只有來源分支與 PR 目標分支相同時才需要開新分支。
|
||||||
|
- **`origin/<current_branch>` 不存在**(當前分支為本地獨有,遠端無對應)→ 依序嘗試切換到後備分支:
|
||||||
|
1. 切換前先確認工作區可安全切換(承接 A1 結果)。若有未提交變更導致切換失敗,停止並回報,請使用者先處理未提交變更;不可強制丟棄。
|
||||||
|
2. 若 `origin/develop` 存在 → 切換到 `develop`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git switch develop 2>/dev/null || git switch -c develop --track origin/develop
|
||||||
|
```
|
||||||
|
|
||||||
|
3. 否則若 `origin/master` 存在 → 切換到 `master`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git switch master 2>/dev/null || git switch -c master --track origin/master
|
||||||
|
```
|
||||||
|
|
||||||
|
4. **`develop` 與 `master` 在遠端都不存在** → 回報「當前分支不在遠端,且找不到 develop/master 後備分支」並停止,不臆測其他分支。
|
||||||
|
- 切換完成後,A4 先更新該後備分支到最新;是否建立新的工作分支交由 A5 依來源分支與 PR 目標分支是否相同判斷。切換到後備分支屬不可忽略的狀態變更,需在輸出中明確告知使用者已從原分支切換到哪一個分支。
|
||||||
|
|
||||||
|
### A4. Pull(更新到最新)
|
||||||
|
|
||||||
|
對當前分支(可能已於 A3 切換為 develop/master)拉取最新:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git pull
|
||||||
|
```
|
||||||
|
|
||||||
|
- pull 成功後進入 A5,必要時建立新的工作分支,再進入階段 B。
|
||||||
|
- 若顯示需要指定 merge / rebase 策略,先回報原因;未帶 `--yes` 時詢問使用者要採用哪種策略,不可自行猜測。
|
||||||
|
- 若 pull 產生衝突,立即告知使用者發生衝突,接著依階段 A6 嘗試解衝突。
|
||||||
|
|
||||||
|
### A5. 只有來源分支與 PR 目標分支相同時,建立新的工作分支
|
||||||
|
|
||||||
|
A4 更新完成後,取得目前來源分支與 PR 目標分支:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
source_branch="$(git rev-parse --abbrev-ref HEAD)"
|
||||||
|
# target 來自 --target;若未提供且後續會建立 PR(未帶 --no-pr),需先依 E1 詢問目標分支。
|
||||||
|
```
|
||||||
|
|
||||||
|
- **若後續會建立 PR(未帶 `--no-pr`)且尚未知道目標分支** → 先依階段 E1 的規則詢問目標分支,避免後續修復 commit 落在與 PR 目標同名的來源分支上才發現 source/base 相同。若帶 `--no-pr`,此階段不因缺少目標分支而詢問。
|
||||||
|
- **若來源分支名稱與目標分支相同** → 不在該分支上直接修復/commit,也不可後續直接建立 head=base 的 PR。從目前已更新到最新的目標分支建立新的工作分支,後續階段(修復、commit、push、PR 的 `head`)都以新分支為準。
|
||||||
|
- **若來源分支名稱與目標分支不同** → 維持目前分支,不另開分支;即使目前分支存在 `origin/<source_branch>`,也照常在目前分支處理。
|
||||||
|
- 新分支名稱需可讀且避免覆蓋既有分支;預設格式:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
work_branch="ai-review-resolve/${source_branch}-$(date +%Y%m%d-%H%M%S)"
|
||||||
|
git switch -c "${work_branch}"
|
||||||
|
```
|
||||||
|
|
||||||
|
- 建立前若本地或遠端已存在同名分支,換一個時間戳或短 hash,不可覆蓋既有分支。
|
||||||
|
- 若因未提交變更導致建立/切換新分支失敗,停止並回報,請使用者先處理未提交變更;不可強制丟棄。
|
||||||
|
- 建立新分支屬不可忽略的狀態變更,需在輸出中明確告知使用者「因來源分支與目標分支同名,已從 `<source_branch>` 建立並切換到 `<work_branch>`」。
|
||||||
|
|
||||||
|
### A6. 必要時嘗試解衝突
|
||||||
|
|
||||||
|
當 `git pull` 後出現衝突,依 `/jsc-shared:spec-git-safety` 的保守解衝突流程處理(定位衝突檔 → 最小合理整合 → 可安全解決者 `git add` 標記、無法安全判斷者停止並列出決策點);全部衝突解完後,依 git 當前狀態完成 merge / rebase 的必要步驟,確認 `git status --porcelain` 沒有未解衝突,再回到 A5 判斷是否需要建立新工作分支。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 B:蒐集問題(findings 檔 + Gitea 議題)合併去重、依嚴重度逐條解決或登記誤報
|
||||||
|
|
||||||
|
新版 AI Code Review 的產出格式(對齊 `https://gitea.jsc.idv.tw/actions/code-review`,`src/index.js` / `src/lib/review.js`):
|
||||||
|
|
||||||
|
- **findings**:每次 review 在目錄 `.gitea/ai-review/findings/` 產生一個**新檔**(檔名為台北時間戳,如 `2026-07-20-14:30:15.json`),內容是**頂層物件(wrapper)**,不是陣列:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"generatedAt": "<台北時間>",
|
||||||
|
"commitSha": "<head sha>",
|
||||||
|
"prNumber": 9,
|
||||||
|
"tool": { "name": "...", "version": "...", "model": "..." },
|
||||||
|
"findings": [ { "<finding>": "..." } ],
|
||||||
|
"excluded": [ { "<finding>": "..." } ]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
每個 `<finding>` 欄位:
|
||||||
|
|
||||||
|
| 欄位 | 語義 |
|
||||||
|
| --- | --- |
|
||||||
|
| `id` | 流水號(`F001`…) |
|
||||||
|
| `reviewer` | 審查角色名稱 |
|
||||||
|
| `focus` | 審查面向代碼(如 `logic`) |
|
||||||
|
| `badge` | 角色徽章(emoji,可空) |
|
||||||
|
| `severity` | 嚴重等級(**中文**:`嚴重` / `警告` / `建議`) |
|
||||||
|
| `file` | 問題所在檔案(repo 相對路徑) |
|
||||||
|
| `startLine` / `endLine` | 問題起訖行號 |
|
||||||
|
| `problem` | 問題描述 |
|
||||||
|
| `suggestion` | 修改建議 |
|
||||||
|
| `suggestedCode` | 建議寫法(程式碼,可空) |
|
||||||
|
|
||||||
|
- **exclusions**:固定 `.gitea/ai-review/exclusions.json`,**頂層陣列**,每筆:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"addedAt": "<台北時間>",
|
||||||
|
"prNumber": 9,
|
||||||
|
"reviewer": "<審查角色>",
|
||||||
|
"severity": "嚴重|警告|建議",
|
||||||
|
"file": "<檔案路徑>",
|
||||||
|
"startLine": 10,
|
||||||
|
"endLine": 12,
|
||||||
|
"problem": "<問題描述>",
|
||||||
|
"reason": "<判定誤報/重複的理由>"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- **建問題模式**:某些 review 不寫 findings 檔,改開 Gitea 議題、把嚴重問題**逐則發成議題留言**(見 B1)。
|
||||||
|
|
||||||
|
> 本 skill 只支援上述**新版格式**;讀到非 wrapper 物件(例如舊版頂層陣列 findings)時,回報格式不符並停止,不臆測欄位。
|
||||||
|
|
||||||
|
### B1. 蒐集問題來源並合併去重
|
||||||
|
|
||||||
|
**不論是否處理議題,都必須先讀取專案內的 findings 檔**;若有指定議題,再加上議題來源,兩者合併去重後才進入 B3。
|
||||||
|
|
||||||
|
**B1a. 讀 findings 檔(一律執行)**
|
||||||
|
|
||||||
|
- 讀目錄 `.gitea/ai-review/findings/` 下所有 `*.json`(含子目錄、依檔名排序)**與**(若存在)單一檔 `.gitea/ai-review/findings.json`;每個檔皆為上述 **wrapper 物件**,取其 `findings` 陣列。
|
||||||
|
- 指定 `--findings <路徑>` 時改讀該路徑(目錄則讀其所有 `*.json`;單一檔則讀該檔),仍須為 wrapper 物件。
|
||||||
|
- 逐筆記住各 finding 的**來源檔路徑與所屬 wrapper**,供 B5 逐檔就地寫回;此步不得更動任何來源檔。
|
||||||
|
- JSON 解析失敗或非 wrapper 物件 → 回報該檔路徑並停止,不臆測、不亂改檔。
|
||||||
|
|
||||||
|
**B1b. 讀議題(依 `--issue` 選擇)**
|
||||||
|
|
||||||
|
`--issue` 支援四種形式:
|
||||||
|
|
||||||
|
| 形式 | 寫法 | 行為 |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| 無 | 省略 `--issue` | 不讀議題,只用 findings 檔 |
|
||||||
|
| 單選 | `--issue 12` | 讀議題 #12 |
|
||||||
|
| 多選 | `--issue 12,15,20` | 讀多個議題(逗號分隔) |
|
||||||
|
| 全部 | `--issue all` | 讀 repo 內**所有 open 議題** |
|
||||||
|
|
||||||
|
1. 解析 repo 座標(同 E3),token 由 `GITEA_TOKEN` 提供。
|
||||||
|
2. `all` 時先取所有 open 議題(分頁全取):`GET /repos/<owner>/<repo>/issues?state=open&type=issues`。
|
||||||
|
3. 對每個選定議題讀本文與全部留言(分頁全取;輸出遮蔽 token):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -sS -H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
"https://<host>/api/v1/repos/<owner>/<repo>/issues/<編號>"
|
||||||
|
curl -sS -H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
"https://<host>/api/v1/repos/<owner>/<repo>/issues/<編號>/comments"
|
||||||
|
```
|
||||||
|
|
||||||
|
4. 解析每則符合「嚴重問題留言」格式(action `severeCommentBody` 產出)的留言為一條 finding:
|
||||||
|
|
||||||
|
```
|
||||||
|
### <emoji> <severity>|<badge> <reviewer>
|
||||||
|
**位置**:`<file>` 第 <startLine>–<endLine> 行
|
||||||
|
**問題**
|
||||||
|
<problem>
|
||||||
|
**修改建議**
|
||||||
|
<suggestion>
|
||||||
|
**建議寫法**(可選)
|
||||||
|
<suggestedCode>
|
||||||
|
```
|
||||||
|
|
||||||
|
映射為 `{ reviewer, severity, file, startLine, endLine, problem, suggestion, suggestedCode }`,並記住**來源議題編號與留言 id**(供 B6 回寫);議題標題/描述作為整體背景脈絡納入判斷。
|
||||||
|
5. 某議題解析不到任何嚴重問題留言 → 記錄並略過該議題(`all`/多選時不因單一議題無問題而中斷整批),不臆測。
|
||||||
|
|
||||||
|
**B1c. 合併去重**
|
||||||
|
|
||||||
|
- 把 B1a(findings 檔)與 B1b(議題)的所有 finding 合併成單一待處理清單。
|
||||||
|
- **去重鍵**:`file` + `startLine` + `endLine` + `reviewer` + `problem`(正規化空白後比對;行號缺失時以 `file` + `reviewer` + `problem` 為準)。
|
||||||
|
- 重複的 finding **合併其來源清單**(同一問題可能同時來自某 findings 檔與某議題),只列入一次;後續解決後要**同時回寫所有來源**(B5 移除該 finding 檔項目、B6 計入相關議題的關閉與留言)。
|
||||||
|
- 合併去重後即為待處理 finding 清單,進入 B3 排序。
|
||||||
|
|
||||||
|
**無任何 finding**(findings 檔皆空/不存在,且未選議題或選到的議題都無問題)→ 視為「無問題待解決」,輸出告知。`--no-commit` 時就此結束;否則**跳過階段 C 直接進入階段 D**。
|
||||||
|
|
||||||
|
### B2. 讀取 exclusions
|
||||||
|
|
||||||
|
`.gitea/ai-review/exclusions.json` 不存在時視為空陣列(頂層陣列);解析失敗或非陣列時回報,並在本次不寫入誤報(避免破壞既有內容、需人工確認)。
|
||||||
|
|
||||||
|
### B3. 依嚴重等級排序
|
||||||
|
|
||||||
|
把所有 finding 依等級由高到低排序:**🔴 嚴重 → 🟠 警告 → 🔵 建議**。
|
||||||
|
`severity` 為中文 `嚴重` / `警告` / `建議`;容錯對應:`嚴重`/`critical`/`high`/`blocker`→🔴、`警告`/`warning`/`major`→🟠、`建議`/`info`/`low`/`minor`→🔵;無法辨識者**排在最後**並標「等級未知」。排序後先處理高等級。
|
||||||
|
|
||||||
|
### B4. 逐條處理(高等級先)
|
||||||
|
|
||||||
|
輸出一張「處理計畫」表,除非使用者要求確認或遇到必要決策,否則**依排序由上而下逐條**處理:
|
||||||
|
|
||||||
|
| # | 等級 | 審查員 | 問題 | 檔案 | 行數 | 處理方式 |
|
||||||
|
| --- | --- | --- | --- | --- | --- | --- |
|
||||||
|
|
||||||
|
對每一條 finding:
|
||||||
|
|
||||||
|
1. 讀取對應檔案與其脈絡(依 `file` 與 `startLine`–`endLine`)。
|
||||||
|
2. 先判斷是否為誤報或不適用:例如程式碼脈絡證明指控不成立、已有等價防護、命中 `exclusions.json` 已知排除、CI/CD 必要權限、或 finding 對非本次變更做不合理要求。
|
||||||
|
3. **可判斷為誤報** → 不改程式碼;將排除條目 append 到 `.gitea/ai-review/exclusions.json`(新版欄位,見 B5),保留原始問題文字與語意;若已有等價 exclusion(同 `file`+`reviewer`+`problem` 高度相似)則不重複新增。
|
||||||
|
4. **確認為真問題且可安全修復** → 依 `suggestion`/`suggestedCode`/`problem` 在程式碼中實作最小合理修正;建議含糊或與現況不符時,依原始碼脈絡做最小且合理的修正。
|
||||||
|
5. **無法安全自動修復或無法確認真偽**(例如需求不明、牽涉設計取捨、檔案不存在)→ **不硬改**,標記為「待人工處理」並記錄原因,繼續下一條。
|
||||||
|
6. 逐條完成後,記錄該條結果(✅ 已解決 / 🚫 誤報已寫入 exclusions / ⏭️ 待人工處理 + 原因),並保留該 finding 依 B1c 記錄的**所有來源**(findings 檔路徑 / 議題編號+留言 id)供 B5/B6 回寫。
|
||||||
|
|
||||||
|
> 一次只處理一條、修完再處理下一條,避免互相干擾;同檔多條問題可合併讀取但仍逐條套用修正。
|
||||||
|
|
||||||
|
### B5. 更新 findings 檔與 exclusions.json
|
||||||
|
|
||||||
|
**所有條目處理完畢後**,依每條 finding 於 B1c 記錄的來源回寫。**只來自議題、無任何 findings 檔來源的 finding 不在本節處理**(交由 B6 回寫議題與新建 findings 檔);有 findings 檔來源者(含同時來自議題與檔案的)依下列更新其來源檔:
|
||||||
|
|
||||||
|
- **只有確認已解決,或已確認為誤報並成功寫入 `exclusions.json` 的 finding,才可從來源 findings 檔移除**;待人工處理、無法確認真偽、修復未驗證成功者一律保留於來源檔。
|
||||||
|
- **逐檔就地更新(wrapper 物件)**:依 B1a 記錄的來源檔,把該檔 `findings` 陣列中要保留的 finding 留下、其餘移除,**只改該檔的 `findings` 陣列**;wrapper 其他欄位(`generatedAt`、`commitSha`、`prNumber`、`tool`、`excluded`)原樣保留,**不得**把多個來源檔合併成單一檔。某檔 `findings` 全數已解決/誤報時,把該檔的 `findings` 寫成 `[]`(保留檔案與 wrapper、維持目錄結構,不刪檔)。
|
||||||
|
- 保留的 finding 維持其原 wrapper 內欄位(`id`、`reviewer`、`severity`、`file`、`startLine`、`endLine`、`problem`、`suggestion`、`suggestedCode`…)與排序。
|
||||||
|
- **誤報一律 append 到 `.gitea/ai-review/exclusions.json`(頂層陣列)**,欄位對齊新版:`addedAt`(當下台北時間,`date` 取得)、`prNumber`(已知則帶、未知可省略)、`reviewer`、`severity`、`file`、`startLine`、`endLine`、`problem`、`reason`(誤報理由);append 後去重。
|
||||||
|
- 誤報移出 findings 前,必須先確認 `exclusions.json` 已成功寫入該條或已有等價條目;寫入失敗則該 finding 保留於來源檔。
|
||||||
|
- 所有寫檔以 UTF-8(不含 BOM)寫入,結尾保留一個換行。
|
||||||
|
|
||||||
|
### B6. 議題收尾:回寫並關閉每個處理過的議題(B1b 有讀到議題時)
|
||||||
|
|
||||||
|
**對每個處理過的議題**(單選/多選/全部各自處理),依該議題涵蓋的 finding 結果收尾:
|
||||||
|
|
||||||
|
1. **在該議題留言回報進度**(Gitea API `POST /repos/<owner>/<repo>/issues/<編號>/comments`,body 以 UTF-8 JSON 檔帶入、token 不 echo):以表格逐條列出該議題各問題結果(✅ 已解決 / 🚫 誤報已寫入 exclusions / ⏭️ 待人工處理 + 原因);同時來自 findings 檔的問題,一併註明已於 B5 更新來源檔。
|
||||||
|
2. **把「待人工處理」且只來自議題的問題寫回 findings**:收集所有 ⏭️ 待人工處理 且**沒有任何 findings 檔來源**的問題(已在 findings 檔的靠 B5 保留,不重複寫),寫成一個**新的 wrapper 物件檔**到目錄 `.gitea/ai-review/findings/`(檔名用台北時間戳,如 `2026-07-20-14:30:15.json`),格式同本階段開頭的 findings wrapper:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"generatedAt": "<台北時間>",
|
||||||
|
"commitSha": "<目前 HEAD sha>",
|
||||||
|
"prNumber": null,
|
||||||
|
"tool": { "name": "review-resolve", "version": "<版本或工具預設>", "model": "<模型或工具預設>" },
|
||||||
|
"findings": [ { "id": "F001", "reviewer": "...", "severity": "嚴重|警告|建議", "file": "...", "startLine": 1, "endLine": 1, "problem": "...", "suggestion": "...", "suggestedCode": "" } ],
|
||||||
|
"excluded": []
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- `findings` 帶入這些待人工處理問題(欄位沿用 B1b 從議題留言解析出的欄位,並補流水號 `id`);`excluded` 固定為 `[]`。多個議題可合寫成同一個檔。
|
||||||
|
- 沒有「只來自議題」的待人工處理問題時**不建立**此檔。
|
||||||
|
- 此新檔屬工作區變更,會在階段 C 一併分類提交(歸 `chore`)。UTF-8(不含 BOM)、結尾保留一個換行。
|
||||||
|
3. **關閉該議題(一律關閉)**:該議題的問題已全部分流為 ✅ 已修復 / 🚫 誤報寫入 exclusions / ⏭️ 待人工處理已寫回 findings(B5 保留或 B6 新建)追蹤,因此收尾時關閉:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -sS -X PATCH -H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
"https://<host>/api/v1/repos/<owner>/<repo>/issues/<編號>" \
|
||||||
|
--data '{"state":"closed"}'
|
||||||
|
```
|
||||||
|
|
||||||
|
關閉前先在步驟 1 的留言中標明各待人工處理項寫回哪個 findings 檔與原因,確保關閉議題不會遺失待辦。
|
||||||
|
4. 誤報仍寫入 `exclusions.json`(同 B5),讓後續 review 沿用。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 C:分析變更並分類提交(`--no-commit` 時略過)
|
||||||
|
|
||||||
|
### C1. 盤點工作區變更
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git status --porcelain=v1 -uall
|
||||||
|
git diff # 已追蹤檔的未暫存變更
|
||||||
|
git diff --staged # 已暫存變更
|
||||||
|
git ls-files --others --exclude-standard # 未追蹤檔
|
||||||
|
```
|
||||||
|
|
||||||
|
盤點時必須以 `git status --porcelain=v1 -uall` 為主,不可只看 `git diff`,因為那會漏掉未追蹤檔。盤點範圍必須包含**所有**變更:已修改檔、新增檔(`??` 未追蹤檔)、刪除檔、改名檔,以及已暫存與未暫存變更。`git diff`、`git diff --staged`、`git ls-files --others --exclude-standard` 只作為輔助核對。**無任何變更** → 回報「工作區無變更可提交」,跳過提交直接進入階段 D(D 會因無 commit 可 push 而跳到階段 E)。
|
||||||
|
|
||||||
|
### C2. 依異動內容歸類 conventional commit 類型
|
||||||
|
|
||||||
|
逐一檢視每個變更檔的**實際異動內容**(不只看路徑),歸入下列其一;**所有 `??` 未追蹤檔都必須納入分類**,不能因為它們不在 `git diff` 裡就漏掉:
|
||||||
|
|
||||||
|
| type | 適用情境 |
|
||||||
|
| --- | --- |
|
||||||
|
| `feat` | 新增功能/新行為/新 API/新 skill |
|
||||||
|
| `fix` | 修正錯誤、修掉 bug(**階段 B 的 bug 修復多半歸此**) |
|
||||||
|
| `docs` | 只改文件(README、註解、`*.md`、說明) |
|
||||||
|
| `style` | 不影響邏輯的格式調整(排版、空白、分號、命名一致化) |
|
||||||
|
| `refactor` | 重構:不改外部行為的內部結構調整 |
|
||||||
|
| `perf` | 效能優化 |
|
||||||
|
| `test` | 新增或修改測試 |
|
||||||
|
| `chore` | 雜項:建置、設定、相依套件、版本號 bump、忽略檔等 |
|
||||||
|
| `revert` | 還原先前的提交 |
|
||||||
|
|
||||||
|
- **同一檔案橫跨多型** → 以該檔**主要異動性質**歸類;難以拆分時就近歸入影響最大的一類,並在總結註記。
|
||||||
|
- **階段 B 修復產生的變更**:依其性質歸類(修 bug→`fix`、補功能→`feat`、改文件→`docs`…)。`.gitea/ai-review/findings/` 目錄下 `*.json`(wrapper)與 `exclusions.json` 的問題狀態更新歸 `chore`。
|
||||||
|
- **未追蹤新檔**:必須照實際內容歸入對應 type,必要時在提交前明確 `git add -- <path>`,不可因為是新檔就略過。
|
||||||
|
|
||||||
|
### C3. 產出提交計畫
|
||||||
|
|
||||||
|
把變更檔依 type 分組,**每個 type 一個 commit**,輸出提交計畫;**所有變更項目都必須被追蹤並納入計畫,不能遺漏任何 `??` 未追蹤檔**。除非使用者要求確認或分組有不可忽略的取捨,否則直接提交:
|
||||||
|
|
||||||
|
| 順序 | type(範圍) | commit 訊息 | 納入檔案 |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
|
||||||
|
- **commit 訊息格式**:`type(範圍): 一句總結` —
|
||||||
|
- `type`:上表英文類型。
|
||||||
|
- `範圍`(括號內):**必須是這組異動實際牽涉的功能/模組/元件名稱**,而**不是**重述 type 的類別詞。
|
||||||
|
取名規則:優先沿用程式碼/專案中既有的識別名(檔名、模組名、skill 名、功能名,可中可英、保持與原碼一致),讓人一眼看出「改到哪個東西」。
|
||||||
|
- ✅ 對:`feat(使用者登入)`、`fix(結帳流程)`、`perf(物件查詢)`、`docs(README)`、`refactor(訂單服務)`、`chore(plugin 版本)`、`feat(review-resolve)`。
|
||||||
|
- ❌ 錯(只是重述 type,禁止):`feat(新增功能)`、`fix(修正錯誤)`、`perf(優化效能)`、`docs(文件)`、`chore(雜項)`。
|
||||||
|
- 一組異動橫跨多個功能而無單一主體時,才退而取最貼近的上層範圍(例如多個 manifest → `plugin 設定`)。
|
||||||
|
- `一句總結`:把這個 commit 內所有異動**總結成一句**繁體中文(簡短、聚焦做了什麼)。
|
||||||
|
- 範例:`feat(使用者登入): 新增帳密登入與 token 簽發`、`fix(結帳流程): 修正空購物車導致的結帳例外`、`perf(物件查詢): 改用批次查詢降低 DB 往返`、`docs(README): 補上安裝與呼叫方式說明`、`chore(ai-review 狀態): 更新 findings 與 exclusions.json`。
|
||||||
|
- **提交順序建議**:`fix`/`feat` 等核心異動在前,`docs`/`style`/`chore` 在後(純屬建議,可依相依性調整)。
|
||||||
|
- **盤點要求**:提交計畫必須完整對應 C1 盤點出的所有變更項目,若有新檔或未追蹤檔,必須明確列入對應 commit,不能只根據 `git diff` 下結論。
|
||||||
|
|
||||||
|
### C4. 執行分類提交
|
||||||
|
|
||||||
|
對每組依序:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git add -- <該組檔案...> # 僅暫存該組檔案,逐組精準 add
|
||||||
|
git commit -m "type(範圍): 一句總結" # 範圍=實際異動的功能/模組名
|
||||||
|
```
|
||||||
|
|
||||||
|
- **逐組 add/commit**,確保每個 commit 只含該類異動;不要一次 `git add -A` 再混在一起。
|
||||||
|
- 改名/刪除檔一併納入對應組的 `git add`(`git add -A -- <路徑>` 或明確列出)。
|
||||||
|
- **所有 `??` 未追蹤檔都必須納入提交**;若是新檔,必要時要明確執行 `git add -- <path>`,不可漏掉。
|
||||||
|
- **不可只根據 `git diff` 判斷變更**;C1 盤點出的所有異動都必須反映到分類與提交,否則視為提交計畫不完整。
|
||||||
|
- commit 完成後進入階段 D(push)。`--no-commit` 時不進入後續階段;若工作區無變更而沒有產生任何新 commit,仍進入階段 D,由 D 判斷無 commit 可 push 後跳到階段 E。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 D:Push 當前分支(`--no-commit` 時略過;無 commit 可 push 時跳到階段 E)
|
||||||
|
|
||||||
|
commit 完成後推送**當前分支**,依序嘗試三種方式,前者失敗才退到下一個:
|
||||||
|
|
||||||
|
推送前先記錄目前來源分支與其遠端基準,並確認是否有 commit 需要 push:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
source_branch="$(git rev-parse --abbrev-ref HEAD)"
|
||||||
|
git rev-parse --verify "origin/${source_branch}"
|
||||||
|
git log --oneline "origin/${source_branch}..${source_branch}" # 領先遠端的 commit
|
||||||
|
```
|
||||||
|
|
||||||
|
- **無 commit 可 push**(來源分支已存在於遠端,且相對 `origin/<source_branch>` 沒有領先 commit)→ **跳過本階段 push,直接進入階段 E**(仍可對既有遠端分支開 PR);若帶 `--no-pr`,則就此結束。
|
||||||
|
- 若來源分支沒有對應的 `origin/<source_branch>`,視為需要 push 的新分支,先記錄「無遠端基準」並繼續;這種情況不需要切回 develop/master,因為 A3 已在同步階段處理「當前分支不存在於遠端」的後備切換。
|
||||||
|
- 若後續會建立 PR(未帶 `--no-pr`)且尚未知道目標分支,先依階段 E1 的規則詢問目標分支,這屬於不可忽略的必要決策。
|
||||||
|
- 若來源分支名稱與目標分支相同,**不要 push 原來源分支**;記下來源分支與遠端基準,直接進入階段 E,由 E2 建立新的 PR 來源分支、帶入 commit 後再 push 新分支。
|
||||||
|
|
||||||
|
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}@<host>/<owner>/<repo>.git" \
|
||||||
|
"$(git rev-parse --abbrev-ref HEAD)"
|
||||||
|
```
|
||||||
|
|
||||||
|
(token 用完即棄,不寫進 git remote 設定、不落地。)
|
||||||
|
|
||||||
|
3. **再失敗 → 詢問使用者要如何 push**:列出失敗原因(遮蔽 token),請使用者指示推送方式,**不可自行猜測**其他憑證或來源。
|
||||||
|
|
||||||
|
push 成功後記下遠端分支名,進入階段 E。若因來源分支與目標分支相同而延後 push,記下原因並進入階段 E2 建立新分支。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 E:透過 Gitea API 發出 PR(`--no-pr`/`--no-commit` 時略過)
|
||||||
|
|
||||||
|
### E1. 確定目標分支(不可猜想)
|
||||||
|
|
||||||
|
- 帶 `--target <分支>` → 直接採用。
|
||||||
|
- 若階段 D 已為了避免 source/base 相同而詢問過目標分支,沿用該目標分支。
|
||||||
|
- **否則必須詢問使用者目標分支**(可用 `git branch -r` 列出輔助選擇),**嚴禁臆測或預設**(不可自行假設 develop/main/master)。
|
||||||
|
|
||||||
|
### E2. 若來源分支與目標分支相同,改建 PR 來源分支
|
||||||
|
|
||||||
|
先取得目前 PR 來源分支:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git rev-parse --abbrev-ref HEAD
|
||||||
|
```
|
||||||
|
|
||||||
|
若來源分支名稱與 `--target` 指定(或使用者選定)的目標分支相同,**不可直接建立 head=base 的 PR,也不可先把原來源分支 push 到目標分支**。改用下列流程建立新的 PR 來源分支,並把原來源分支的 commit 帶入後再開 PR:
|
||||||
|
|
||||||
|
1. 先記錄原來源分支名稱與要帶入的 commit 清單:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
source_branch="$(git rev-parse --abbrev-ref HEAD)"
|
||||||
|
git log --oneline "origin/${target}..${source_branch}"
|
||||||
|
```
|
||||||
|
|
||||||
|
- 若 `origin/<target>` 不存在,先回報並停止,不猜測替代 base。
|
||||||
|
- 若沒有任何 commit 可帶入,回報「來源分支沒有領先目標分支的 commit」,停止開 PR。
|
||||||
|
- 若階段 D 已記錄來源分支的遠端基準,使用該基準判斷要帶入的 commit,避免把原來源分支直接推進目標分支。
|
||||||
|
|
||||||
|
2. 從目標分支的遠端基準建立新分支。新分支名稱需可讀且避免覆蓋既有分支,例如:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git switch -c "ai-review-resolve/<短時間戳>" "origin/${target}"
|
||||||
|
```
|
||||||
|
|
||||||
|
3. 將原來源分支領先目標分支的 commit 依序帶入新分支:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git cherry-pick "origin/${target}..${source_branch}"
|
||||||
|
```
|
||||||
|
|
||||||
|
- cherry-pick 發生衝突時,先告知使用者,再依專案脈絡嘗試最小合理解衝突。
|
||||||
|
- 可安全解決的衝突:移除衝突標記、`git add -- <檔案...>`,再繼續 `git cherry-pick --continue`。
|
||||||
|
- 無法安全判斷的衝突:停止處理,列出衝突檔案與需要使用者決策的點;不要硬選任一邊。
|
||||||
|
|
||||||
|
4. 將新分支 push 到遠端,使用階段 D 的同一套 push 憑證策略,並把後續 PR 的 `head` 改為這個新分支。
|
||||||
|
|
||||||
|
若來源分支與目標分支不同,直接以目前分支作為 PR 的 `head`。
|
||||||
|
|
||||||
|
### E3. 解析 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`)。
|
||||||
|
|
||||||
|
### E4. 決定 PR 描述形式(完整版/簡單版/使用者輸入)
|
||||||
|
|
||||||
|
依 `--pr-desc` 三選一;若未提供則預設使用 `full`,不要為描述形式中斷詢問:
|
||||||
|
|
||||||
|
- **完整版(`full`)**:**重新分析並總結** `git diff <target>...<PR 來源分支>`(比對 source 自分岔點以來的變更),整理成結構化繁體中文說明 —— 變更摘要、影響範圍、重點檔案/模組、風險或注意事項。不是貼原始 diff,而是「人讀得懂的總結」。
|
||||||
|
- **簡單版(`simple`)**:直接把本分支領先 target 的 commit 訊息**逐條列出**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git log --oneline "<target>..<PR 來源分支>"
|
||||||
|
```
|
||||||
|
|
||||||
|
以條列呈現每行 commit 訊息。
|
||||||
|
- **使用者輸入**:採用使用者提供的描述文字。
|
||||||
|
|
||||||
|
PR **標題**預設取一句總結(可用首個 feat/fix commit 或分支用途);使用者另有指定則從之。
|
||||||
|
|
||||||
|
產生 PR body 時必須使用實際換行與 Markdown 內容,不可把跳脫字串當作正文送出。若用 shell / `jq` 組 JSON,應以 UTF-8 暫存檔、heredoc、`printf` 或 `jq --rawfile` 帶入內容;避免讓 PR 顯示成 `## Commit\n\n- ...` 這類字面 `\n`。
|
||||||
|
|
||||||
|
### E5. 呼叫 Gitea API 建立 PR(使用 token)
|
||||||
|
|
||||||
|
token 從環境變數讀取,呼叫 Gitea 建立 PR:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 不可 echo 含 token 的指令;body 以 UTF-8 JSON 檔帶入,輸出時遮蔽 token
|
||||||
|
# PR 描述內的換行必須是實際換行,不可使用字面 \n
|
||||||
|
curl -sS -X POST \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
"https://<host>/api/v1/repos/<owner>/<repo>/pulls" \
|
||||||
|
--data @body.json
|
||||||
|
```
|
||||||
|
|
||||||
|
- **成功**:取回應中的 PR 連結/編號回報使用者。
|
||||||
|
- **失敗**:顯示 API 回應的錯誤訊息供排查(**先遮蔽 token**)。常見錯誤:目標分支不存在、已有相同 head→base 的 PR、token 權限不足。
|
||||||
|
|
||||||
|
### E6. 完成通知 + 清除對話內文(重要:可能含 token)
|
||||||
|
|
||||||
|
1. **通知使用者**:push 結果、PR 連結/編號、PR 描述採用哪種形式。
|
||||||
|
2. **清除 AI 助理對話內文**:因為 push/API 過程可能使對話內文殘留 gitea token,**完成後務必清除對話內文/上下文**以免外洩:
|
||||||
|
- Claude Code:提示使用者執行 `/clear`(或依當前助理對等指令清空對話)。
|
||||||
|
- 其他助理:執行各自清除對話/上下文的方式。
|
||||||
|
- 在清除前,請再次確認輸出與 log 中沒有任何明文 token。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 總結
|
||||||
|
|
||||||
|
各階段執行後輸出:
|
||||||
|
|
||||||
|
- **階段 A**:git fetch / pull 是否成功、當前分支是否存在於遠端(不存在時切到 develop/master 的結果)、若來源分支與目標分支同名是否已建立新工作分支、是否發生衝突、衝突是否已解決或仍需人工處理。
|
||||||
|
- **階段 B**:問題來源(findings 檔筆數+議題來源:無/`#N`/多個/全部)、合併去重後總數、已解決 N 條(依等級分佈)、誤報寫入 exclusions M 條、待人工處理 K 條(列出原因)、來源 findings 檔保留/移除筆數與 `exclusions.json` 新增筆數;有處理議題時另報各議題已留言、只來自議題的待人工問題寫回哪個 findings 檔、以及各議題已關閉;若無待處理問題,說明已跳過階段 C 直接進入階段 D。
|
||||||
|
- **階段 C**:建立了哪幾個 commit(type+訊息+檔數),或為何略過(`--no-commit` / 無變更)。
|
||||||
|
- **階段 D**:push 成功與否、用了哪種方式(認證管理器/token/使用者指定),遠端分支名;若無 commit 可 push,說明已跳過 push 直接進入階段 E。
|
||||||
|
- **階段 E**:PR 連結/編號、目標分支、描述形式;並提醒已(或請使用者)清除對話內文以防 token 外洩。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 呼叫方式
|
||||||
|
|
||||||
|
格式:`[--findings <路徑>] [--target <目標分支>] [--pr-desc <full|simple|自訂文字>] [--no-commit] [--no-pr] [--yes]` —
|
||||||
|
除 `--target` 外皆可省略(findings 一律讀目錄 `.gitea/ai-review/findings/` 下所有 wrapper `*.json` 與 `findings.json`;`--issue` 無/單選/多選/全部 額外從 Gitea 議題取問題,與 findings 合併去重;目標分支省略時必問、不猜測)。token 一律由環境變數(如 `GITEA_TOKEN`)提供。
|
||||||
|
|
||||||
|
| 助理 | 呼叫 |
|
||||||
|
| --- | --- |
|
||||||
|
| Claude Code / Antigravity | `/jsc-code:review-resolve`,或 `/jsc-code:review-resolve --target develop --pr-desc full --yes`、`/jsc-code:review-resolve --issue 12,15 --target master`、`/jsc-code:review-resolve --issue all --target master`、`/jsc-code:review-resolve --no-pr`、`/jsc-code:review-resolve --no-commit` |
|
||||||
|
| Codex | `$review-resolve`,或 `$review-resolve --target develop --pr-desc full --yes`、`$review-resolve --issue all --target master`,或用 `/skills` 選單 |
|
||||||
|
| OpenCode | 描述需求(如「讀 .gitea/ai-review/findings/ 目錄與 findings.json 的 wrapper findings,再併入議題 #12、#15 的 code review 問題去重後依嚴重度逐條處理,更新 findings/exclusions,把工作區變更依 conventional commit 分類提交,push 後對 develop 發 PR(完整版描述)」)自動觸發 |
|
||||||
@@ -0,0 +1,219 @@
|
|||||||
|
---
|
||||||
|
name: sync
|
||||||
|
description: 透過 `GITEA_TOKEN` 取得使用者有讀取權限的所有 Gitea 專案,依擁有者(owner)分組後列出讓使用者多選,再把選定擁有者底下有讀取權限的專案,於目標目錄(預設家目錄)依擁有者建立資料夾並逐一 clone;若專案已存在,則切換到 develop(再退而 master)並更新到最新。當使用者說同步 Gitea 專案、批次 clone、把某些擁有者的 repo 全抓下來、依擁有者分類 clone、批次更新本機專案到最新時觸發。不適用於:建立/刪除遠端 repo、單一專案的 clone(直接用 git 即可)、非 Gitea 的來源,或需要 push/改動遠端的操作。
|
||||||
|
argument-hint: "[--target-dir <根目錄>] [--owner <擁有者,以逗號分隔>] [--host <gitea 主機>] [--include-forks] [--ssh] [--yes]"
|
||||||
|
---
|
||||||
|
|
||||||
|
# sync — 依擁有者批次 clone/更新 Gitea 專案
|
||||||
|
|
||||||
|
五階段 skill:先做**前置設定**(解析 token、gitea 主機、目標根目錄),再**取得使用者有讀取權限的所有專案並依擁有者分組**,接著**列出所有擁有者讓使用者多選**,然後**列出選定擁有者底下有讀取權限的專案**,最後在目標根目錄**依擁有者建立資料夾並逐一 clone**;專案已存在時改為**切換到 develop(再退而 master)並更新到最新**。
|
||||||
|
|
||||||
|
| 階段 | 動作 |
|
||||||
|
| --- | --- |
|
||||||
|
| A. 前置設定 | 確認 `GITEA_TOKEN` → 決定 gitea 主機(`--host`/`$GITEA_HOST`/目前 repo 的 origin/詢問)→ 決定目標根目錄(`--target-dir`,預設家目錄) |
|
||||||
|
| B. 取得可讀專案 | 以 token 呼叫 Gitea API 分頁取回使用者有讀取(`pull`)權限的所有專案 → 依 `owner.login` 分組 |
|
||||||
|
| C. 選擇擁有者 | 列出所有擁有者(含各自專案數)→ 讓使用者**多選**(`--owner` 已指定則沿用,不再詢問) |
|
||||||
|
| D. 列出選定專案 | 列出選定擁有者底下所有有讀取權限的專案(含是否已存在於本機) |
|
||||||
|
| E. Clone/更新 | 依擁有者建立資料夾 → 不存在則 clone;已存在則 `fetch` → 切到 develop(再退而 master)→ `pull` 更新到最新 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 共用規範(shared plugin,必要前置)
|
||||||
|
|
||||||
|
執行本 skill 前,先以 Skill 工具載入下列共用規範並全程遵守;**任一載入不到(shared plugin 未安裝)時,先詢問使用者是否安裝 shared plugin(`https://gitea.jsc.idv.tw/plugins/shared.git`),使用者不安裝則直接中斷本 skill**,不得只憑下方一行摘要繼續執行:
|
||||||
|
|
||||||
|
- `/jsc-shared:spec-output`:繁體中文(台灣用語)、UTF-8(不含 BOM)無亂碼。
|
||||||
|
- `/jsc-shared:spec-execution`:自動執行原則(必要決策才中斷)、不臆測/需人工確認。
|
||||||
|
- `/jsc-shared:spec-gitea`:`GITEA_TOKEN` 機密保護(不 echo、遮蔽、clone 後還原乾淨 origin)、API 分頁完整讀取、host 決定順序。
|
||||||
|
- `/jsc-shared:spec-git-safety`:不破壞既有工作(未提交變更不強切、絕不 `reset --hard`/`clean`)、develop → master 後備、`pull --ff-only`。
|
||||||
|
|
||||||
|
本 skill 特有補充:
|
||||||
|
|
||||||
|
- **必要決策**(會中斷詢問):缺 token、無法決定 gitea 主機、目標目錄不可寫、單一專案更新時工作區有未提交變更需使用者裁示。**唯一一定會中斷的點是階段 C 的擁有者多選**(除非已帶 `--owner`)。
|
||||||
|
- **唯讀本意**:本 skill 只做 clone 與本機分支更新,**不 push、不改遠端、不刪本機未追蹤檔**。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 參數
|
||||||
|
|
||||||
|
格式:`[--target-dir <根目錄>] [--owner <擁有者,以逗號分隔>] [--host <gitea 主機>] [--include-forks] [--ssh] [--yes]`
|
||||||
|
|
||||||
|
- `--target-dir <根目錄>`:clone 的根目錄。**省略時預設家目錄**(`$HOME`,Windows 為 `%USERPROFILE%`)。實際每個專案會 clone 到 `<根目錄>/<擁有者>/<專案名>`。
|
||||||
|
- `--owner <擁有者,以逗號分隔>`:預先指定要同步的擁有者(可多個,以逗號分隔,例如 `plugins,jeffery`)。**帶此參數時跳過階段 C 的多選詢問**,直接同步這些擁有者;若指定的擁有者不在可讀清單內,回報並略過該擁有者。
|
||||||
|
- `--host <gitea 主機>`:gitea 主機(如 `gitea.jsc.idv.tw`)。省略時依 A2 規則決定。
|
||||||
|
- `--include-forks`:一併納入 fork 來的專案;**省略時預設排除 fork**(`fork=true` 的 repo 不列入)。
|
||||||
|
- `--ssh`:改用 SSH(`ssh_url`)clone,不帶 token;**省略時預設用 HTTPS+token**。
|
||||||
|
- `--yes`:全自動。即使未帶此參數,也依「自動執行原則」盡量不中斷;但階段 C 的擁有者多選仍會詢問(除非已帶 `--owner`)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 A:前置設定
|
||||||
|
|
||||||
|
### A1. 確認 token
|
||||||
|
|
||||||
|
依 `/jsc-shared:spec-gitea` 確認 `GITEA_TOKEN`(只輸出「已設定/未設定」,不可 echo token 本身);**未設定** → 回報「缺少 `GITEA_TOKEN` 環境變數,無法存取 Gitea API」並停止(不要請使用者把 token 貼進對話)。
|
||||||
|
|
||||||
|
### A2. 決定 gitea 主機
|
||||||
|
|
||||||
|
依 `/jsc-shared:spec-gitea` 的 host 決定順序:`--host` → `$GITEA_HOST` → 目前 repo 的 origin → 詢問使用者(不臆測)。主機僅取 host 部分(如 `gitea.jsc.idv.tw`),組 API base 為 `https://<host>/api/v1`。
|
||||||
|
|
||||||
|
### A3. 決定目標根目錄
|
||||||
|
|
||||||
|
- 帶 `--target-dir <根目錄>` → 採用(可含 `~`,需展開為實際家目錄)。
|
||||||
|
- 省略 → 預設家目錄(`$HOME`)。
|
||||||
|
- 確認根目錄存在且可寫;不存在時先建立(`mkdir -p`)。若無法建立或不可寫,回報並停止。
|
||||||
|
|
||||||
|
輸出本次設定摘要(主機、根目錄、是否含 fork、HTTPS/SSH),再進入階段 B。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 B:取得使用者有讀取權限的所有專案並依擁有者分組
|
||||||
|
|
||||||
|
### B1. 分頁取回可讀專案
|
||||||
|
|
||||||
|
以 token 呼叫 `GET /api/v1/user/repos`(回傳 token 對應使用者**有權限存取**的 repo:自有、組織成員、協作者),**逐頁抓到取回筆數不足一頁為止**(每頁上限以 API 為準,常見 `limit=50`):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 不可印出含 token 的指令;token 以 Header 帶入,輸出時遮蔽
|
||||||
|
page=1
|
||||||
|
curl -sS \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
"https://<host>/api/v1/user/repos?page=${page}&limit=50"
|
||||||
|
```
|
||||||
|
|
||||||
|
- 持續累加 `page` 直到某頁回傳筆數 `< limit`(或回空陣列)為止,確保**取得全部**而非只第一頁。
|
||||||
|
- API 失敗(401/403/網路錯誤)→ 回報錯誤(**遮蔽 token**)並停止;401/403 多半是 token 失效或權限不足。
|
||||||
|
|
||||||
|
### B2. 篩選與正規化
|
||||||
|
|
||||||
|
每筆 repo 取下列欄位:`owner.login`、`name`、`full_name`、`clone_url`、`ssh_url`、`permissions.pull`、`fork`、`default_branch`。
|
||||||
|
|
||||||
|
- **只保留 `permissions.pull == true`** 的專案(確有讀取權限)。
|
||||||
|
- **預設排除 `fork == true`**;帶 `--include-forks` 才納入。
|
||||||
|
- 去除重複(以 `full_name` 為鍵)。
|
||||||
|
|
||||||
|
### B3. 依擁有者分組
|
||||||
|
|
||||||
|
以 `owner.login` 分組,統計每個擁有者底下的可讀專案數,並依擁有者名稱排序(專案數多者可優先列出)。**無任何可讀專案** → 回報並結束。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 C:列出所有擁有者讓使用者多選
|
||||||
|
|
||||||
|
輸出一張「擁有者清單」表,含編號、擁有者、可讀專案數:
|
||||||
|
|
||||||
|
| # | 擁有者 | 可讀專案數 |
|
||||||
|
| --- | --- | --- |
|
||||||
|
|
||||||
|
選擇方式:
|
||||||
|
|
||||||
|
- **帶 `--owner` 參數** → 直接採用其中的擁有者,**跳過詢問**;清單中沒有的擁有者回報並略過。
|
||||||
|
- **未帶 `--owner`** → 這是**不可忽略的必要決策**,必須讓使用者**多選**:
|
||||||
|
- 擁有者數量 ≤ 4 時,可用助理的多選提問元件(如 Claude Code 的多選問題)。
|
||||||
|
- 擁有者較多時,請使用者直接以**編號或擁有者名稱**回覆(支援多個,以逗號或空白分隔),並支援回覆 `all`/`全部` 代表全選。
|
||||||
|
- 解析使用者回覆為擁有者集合;無法對應的輸入請回報並請使用者重選,**不臆測**。
|
||||||
|
|
||||||
|
選定後輸出「將同步的擁有者:…」再進入階段 D。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 D:列出選定擁有者底下有讀取權限的專案
|
||||||
|
|
||||||
|
對每個選定擁有者,列出其底下所有可讀專案,並標示本機是否已存在(`<根目錄>/<擁有者>/<專案名>/.git` 是否存在):
|
||||||
|
|
||||||
|
| 擁有者 | 專案 | 狀態 |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| | | 🆕 將 clone/♻️ 已存在將更新 |
|
||||||
|
|
||||||
|
輸出總計(將 clone N 個、將更新 M 個),除非使用者要求先確認,否則直接進入階段 E 執行。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 E:依擁有者建立資料夾並逐一 clone/更新
|
||||||
|
|
||||||
|
對選定擁有者底下的每個專案,依序處理(一次一個,互不干擾):
|
||||||
|
|
||||||
|
### E1. 建立擁有者資料夾
|
||||||
|
|
||||||
|
```bash
|
||||||
|
mkdir -p "<根目錄>/<擁有者>"
|
||||||
|
```
|
||||||
|
|
||||||
|
專案目標路徑為 `<根目錄>/<擁有者>/<專案名>`。
|
||||||
|
|
||||||
|
### E2. 專案不存在 → clone
|
||||||
|
|
||||||
|
- **HTTPS(預設)**:以 token 組 clone URL,**用變數帶入、不可印出**;clone 完成後**還原乾淨 origin**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
dest="<根目錄>/<擁有者>/<專案名>"
|
||||||
|
# GITEA_TOKEN 來自環境變數;clone_url 形如 https://<host>/<owner>/<repo>.git
|
||||||
|
git clone "https://oauth2:${GITEA_TOKEN}@<host>/<owner>/<repo>.git" "${dest}"
|
||||||
|
# 還原成不含 token 的乾淨 URL,避免 token 落地在 .git/config
|
||||||
|
git -C "${dest}" remote set-url origin "https://<host>/<owner>/<repo>.git"
|
||||||
|
```
|
||||||
|
|
||||||
|
- **SSH(`--ssh`)**:直接用 `ssh_url`,不帶 token:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone "<ssh_url>" "<根目錄>/<擁有者>/<專案名>"
|
||||||
|
```
|
||||||
|
|
||||||
|
- clone 後若遠端有 `develop`,將工作分支切到 `develop`(沒有則維持 `default_branch`/`master`);clone 失敗回報原因(**遮蔽 token**)並繼續下一個專案,不中斷整批。
|
||||||
|
|
||||||
|
### E3. 專案已存在 → 切到 develop(再退而 master)並更新到最新
|
||||||
|
|
||||||
|
先盤點該專案狀態,**有未提交變更則不強切**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
dest="<根目錄>/<擁有者>/<專案名>"
|
||||||
|
git -C "${dest}" rev-parse --is-inside-work-tree # 確認是 git repo
|
||||||
|
git -C "${dest}" status --porcelain # 是否乾淨
|
||||||
|
git -C "${dest}" fetch --all --prune
|
||||||
|
```
|
||||||
|
|
||||||
|
- **目錄存在但不是 git repo**(無 `.git`)→ 回報「目標已存在且非 git repo,略過」並繼續下一個;**不刪除、不覆蓋**。
|
||||||
|
- **工作區有未提交變更**(`status --porcelain` 非空)→ 回報「有未提交變更,略過更新以免覆蓋」並繼續下一個;**絕不**強制丟棄。
|
||||||
|
- **工作區乾淨** → 依序選擇要更新的分支並切換、拉取:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
if git -C "${dest}" rev-parse --verify --quiet origin/develop; then
|
||||||
|
git -C "${dest}" switch develop 2>/dev/null || git -C "${dest}" switch -c develop --track origin/develop
|
||||||
|
elif git -C "${dest}" rev-parse --verify --quiet origin/master; then
|
||||||
|
git -C "${dest}" switch master 2>/dev/null || git -C "${dest}" switch -c master --track origin/master
|
||||||
|
fi
|
||||||
|
git -C "${dest}" pull --ff-only
|
||||||
|
```
|
||||||
|
|
||||||
|
- `origin/develop` 存在 → 切到 `develop`;否則 `origin/master` 存在 → 切到 `master`;兩者都不存在 → 回報「找不到 develop/master」並維持原分支、略過該專案。
|
||||||
|
- `pull --ff-only` 無法快進(本地與遠端分歧)→ 回報該專案需人工處理(**不**自動 merge/rebase/reset),繼續下一個。
|
||||||
|
- 已在目標分支時直接 `pull --ff-only` 更新即可。
|
||||||
|
|
||||||
|
### E4. 逐一處理、彙整結果
|
||||||
|
|
||||||
|
- 每個專案處理完記錄結果:🆕 已 clone/♻️ 已更新到最新/⏭️ 已略過(原因)/❌ 失敗(原因,遮蔽 token)。
|
||||||
|
- 單一專案失敗或略過**不應中斷整批**;全部處理完再輸出總結。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 總結
|
||||||
|
|
||||||
|
各階段執行後輸出:
|
||||||
|
|
||||||
|
- **階段 A**:使用的 gitea 主機、目標根目錄、是否含 fork、HTTPS/SSH。
|
||||||
|
- **階段 B/C**:可讀專案總數、擁有者總數、使用者選定的擁有者。
|
||||||
|
- **階段 D/E**:本批處理結果統計 —— 新 clone N 個、更新 M 個、略過 K 個(列原因)、失敗 J 個(列原因,遮蔽 token),並列出各專案的本機路徑。
|
||||||
|
- 若過程曾在指令中帶入 token,提醒確認輸出與 log 無明文 token。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 呼叫方式
|
||||||
|
|
||||||
|
格式:`[--target-dir <根目錄>] [--owner <擁有者,以逗號分隔>] [--host <gitea 主機>] [--include-forks] [--ssh] [--yes]` —
|
||||||
|
全部可省略(根目錄預設家目錄;未帶 `--owner` 時於階段 C 詢問多選)。token 一律由環境變數(如 `GITEA_TOKEN`)提供,不寫死、不印出。
|
||||||
|
|
||||||
|
| 助理 | 呼叫 |
|
||||||
|
| --- | --- |
|
||||||
|
| Claude Code / Antigravity | `/jsc-code:sync`,或 `/jsc-code:sync --owner plugins --target-dir ~/work`、`/jsc-code:sync --include-forks --ssh` |
|
||||||
|
| Codex | `$sync`,或 `$sync --owner plugins --target-dir ~/work`,或用 `/skills` 選單 |
|
||||||
|
| OpenCode | 描述需求(如「用 GITEA_TOKEN 取得我有讀取權限的所有 Gitea 專案,依擁有者分組讓我多選,把選定擁有者的專案 clone 到家目錄;已存在的切到 develop/master 更新到最新」)自動觸發 |
|
||||||
@@ -0,0 +1,342 @@
|
|||||||
|
---
|
||||||
|
name: target
|
||||||
|
description: 用專案根目錄的 `TARGET.md` 當每日待辦清單,並以系統排程(Linux/WSL/macOS 用 crontab、Windows 用 schtasks)在每天 00:00 自動跑完它。`--schedule on` 建立或更新排程、`--schedule off` 移除排程、`--run` 立即(或由排程)執行一次:先同步 git 並切到 `develop`(遠端沒有就從預設分支建立),逐項實作 `TARGET.md` 中未勾選的項目、完成一項就勾選並補完成時間,接著把工作區變更依 conventional commit 類型分類提交、push `develop`,最後透過 Gitea API 對**遠端預設分支**發 PR(已有同 head→base 的 open PR 就沿用不重開)。當使用者說把 TARGET.md 排成每天執行、每天半夜自動跑待辦、開啟/關閉每日自動任務、建立每日排程做完 TARGET、移除 TARGET 排程、跑一次 TARGET.md 的項目、讓 AI 每天自動做完待辦並發 PR,或提到 TARGET.md、每日排程、cron 每天 00:00、schtasks 每日任務時觸發。不適用於:解決 AI review findings(用 review-resolve)、實作 Gitea 議題的 TODO(用 issues)、角色記憶的睡眠排程(用 role)。
|
||||||
|
argument-hint: "[--schedule on|off] [--run] [--project-dir <專案根目錄>] [--cli <claude|codex|agy|opencode|copilot>] [--base <PR 目標分支>] [--no-pr] [--yes]"
|
||||||
|
---
|
||||||
|
|
||||||
|
# target — TARGET.md 每日排程執行、提交、push develop 並發 PR
|
||||||
|
|
||||||
|
兩個用途合在一個 skill:**管理排程**(開/關每天 00:00 的系統排程)與**執行一次**(把 `TARGET.md` 的待辦做完並走完 git 流程)。排程觸發時,執行的就是本 skill 的 `--run`。
|
||||||
|
|
||||||
|
| 模式 | 觸發 | 動作 |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `--schedule on` | 使用者 | 依 OS 建立/更新「每天 00:00 執行本 skill `--run`」的系統排程(同一專案只會有一筆) |
|
||||||
|
| `--schedule off` | 使用者 | 移除該專案的排程條目(只動自己那筆,不碰使用者其他排程) |
|
||||||
|
| `--run` | 排程/使用者 | A Git 同步(切到 develop,沒有就建立)→ B 讀 `TARGET.md` → C 逐項實作並勾選 → D 分類提交 → E push develop → F 對預設分支發 PR |
|
||||||
|
| 不帶參數 | 使用者 | 只回報現況:排程裝了沒、下次執行時間、`TARGET.md` 還剩幾項未完成 |
|
||||||
|
|
||||||
|
`--schedule` 與 `--run` 可同時帶(`--schedule on --run` = 裝好排程並立刻先跑一次)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 共用規範(shared plugin,必要前置)
|
||||||
|
|
||||||
|
執行本 skill 前,先以 Skill 工具載入下列共用規範並全程遵守;**任一載入不到(shared plugin 未安裝)時,先詢問使用者是否安裝 shared plugin(`https://gitea.jsc.idv.tw/plugins/shared.git`),使用者不安裝則直接中斷本 skill**,不得只憑下方一行摘要繼續執行:
|
||||||
|
|
||||||
|
- `/jsc-shared:spec-output`:繁體中文(台灣用語)、UTF-8(不含 BOM)無亂碼(含 `TARGET.md` 回寫、commit 訊息、PR 標題/描述)、表格呈現。
|
||||||
|
- `/jsc-shared:spec-execution`:自動執行原則(必要決策才中斷)、不臆測/需人工確認。
|
||||||
|
- `/jsc-shared:spec-git-safety`:不破壞既有工作(絕不 `reset --hard`/`clean`)、`pull --ff-only`、保守解衝突、新分支不覆蓋既有分支。
|
||||||
|
- `/jsc-shared:spec-gitea`:`GITEA_TOKEN` 機密保護(不 echo、遮蔽 `***`)、API body 以 UTF-8 JSON 檔帶入。
|
||||||
|
- `/jsc-shared:spec-time-log`:Asia/Taipei `yyyy/MM/dd HH:mm:ss` 時間格式、`[時間][階段][等級]: 訊息` log 格式。
|
||||||
|
|
||||||
|
本 skill 特有補充:
|
||||||
|
|
||||||
|
- **排程只動自己那一筆**:安裝/移除都以固定標記比對,**絕不覆寫整份 crontab、不刪別人的排程任務**。
|
||||||
|
- **排程情境沒有人在旁邊**:`--run` 遇到必要決策時**停下來並寫進 log**,不得臆測後硬做;下次執行會再遇到同一個決策點,由使用者處理。
|
||||||
|
- **必要決策**(會中斷詢問):工作區有未提交變更、`origin` 無法解析、找不到遠端預設分支、`TARGET.md` 項目語意不明無法安全實作、push 憑證皆失敗、無法判斷目前是哪個助理(且未帶 `--cli`)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 參數
|
||||||
|
|
||||||
|
格式:`[--schedule on|off] [--run] [--project-dir <專案根目錄>] [--cli <claude|codex|agy|opencode|copilot>] [--base <PR 目標分支>] [--no-pr] [--yes]`
|
||||||
|
|
||||||
|
- `--schedule on|off`:`on` 建立/更新排程,`off` 移除排程。省略時不動排程。
|
||||||
|
- `--run`:立即執行一次 `TARGET.md`(排程條目帶的就是這個)。
|
||||||
|
- `--project-dir <專案根目錄>`:目標專案根目錄,**省略時取目前工作目錄**(會先 `git rev-parse --show-toplevel` 正規化成 repo 根)。`TARGET.md` 固定讀**專案根目錄**的那一份。
|
||||||
|
- `--cli <claude|codex|agy|opencode|copilot>`:排程條目要用哪個助理的 headless 指令。省略時用**目前正在執行本 skill 的助理**;判斷不出來且未帶此參數 → 詢問,不猜測。
|
||||||
|
- `--base <PR 目標分支>`:PR 的目標分支。**省略時自動取遠端預設分支**(見 F1),取不到才詢問。
|
||||||
|
- `--no-pr`:執行到 push 為止,不開 PR。
|
||||||
|
- `--yes`:全自動,不做確認式詢問(必要決策仍會中斷)。
|
||||||
|
|
||||||
|
執行時間固定為**每天 00:00**(本機時區),不提供時間參數;要改時間請直接編輯排程條目。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## `TARGET.md` 格式
|
||||||
|
|
||||||
|
專案根目錄的 `TARGET.md`,用 Markdown checklist 表示待辦:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
# TARGET
|
||||||
|
|
||||||
|
- [ ] 補上使用者服務的單元測試
|
||||||
|
- [ ] 把 README 的安裝章節更新成新的 CLI 指令
|
||||||
|
- [ ] 順便修掉裡面過期的截圖連結
|
||||||
|
- [x] 移除已停用的舊設定檔(2026/08/02 23:41:07 完成)
|
||||||
|
```
|
||||||
|
|
||||||
|
| 規則 | 說明 |
|
||||||
|
| --- | --- |
|
||||||
|
| 待辦 | `- [ ]` 未勾選的項目,**由上而下**依序處理 |
|
||||||
|
| 已完成 | `- [x]` 直接略過,不重做 |
|
||||||
|
| 子項目 | 縮排的 `- [ ]` 視為上層項目的子步驟,隨上層一起處理;子項目全部完成才勾選上層 |
|
||||||
|
| 標題/說明文字 | 原樣保留,只當作項目的背景脈絡,不改寫 |
|
||||||
|
| 檔案不存在 | `--run` 視為「無待辦」正常結束(不建檔、不報錯);`--schedule on` 則提醒尚無 `TARGET.md`,非 `--yes` 時詢問是否仍要建立排程 |
|
||||||
|
|
||||||
|
完成一項後就地改成 `- [x]`,並在該行**行尾**補上 `(<yyyy/MM/dd HH:mm:ss> 完成)`(Asia/Taipei)。無法安全完成的項目**保持未勾選**,並在該行下方以縮排補一行 `> ⏭️ 待人工處理:<原因>`(已有同樣註記則更新而非重複新增)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 S:管理排程(`--schedule on|off`)
|
||||||
|
|
||||||
|
### S1. 判定 OS 與排程機制
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uname -s # Linux / Darwin / MINGW*|MSYS*|CYGWIN*(後者代表在 Windows 的 git bash)
|
||||||
|
```
|
||||||
|
|
||||||
|
| 環境 | 機制 | 備註 |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| Linux、WSL | `crontab` | WSL 的 cron **預設不會自動啟動**,見 S5 |
|
||||||
|
| macOS | `crontab` | 可用;若使用者偏好 `launchd` 需自行改寫,本 skill 不代為產生 plist |
|
||||||
|
| Windows(PowerShell/cmd) | `schtasks` | 每日任務 |
|
||||||
|
|
||||||
|
判斷不出環境時停止並回報,不臆測。
|
||||||
|
|
||||||
|
### S2. 組出排程要執行的指令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
proj="$(cd "<專案根目錄>" && git rev-parse --show-toplevel)" # 絕對路徑
|
||||||
|
log="$HOME/.jsc/target-$(basename "$proj").log"
|
||||||
|
```
|
||||||
|
|
||||||
|
log **刻意放在專案外面**:放進 repo 會讓每次執行都多出未追蹤檔,污染 D 階段的變更盤點。
|
||||||
|
|
||||||
|
各助理的 headless 指令(依 `--cli`):
|
||||||
|
|
||||||
|
| `--cli` | 指令 |
|
||||||
|
| --- | --- |
|
||||||
|
| `claude` | `claude -p "/jsc-code:target --run --yes"` |
|
||||||
|
| `codex` | `codex exec '$target --run --yes'`(單引號,避免 `$` 被 shell 展開) |
|
||||||
|
| `agy` | `agy -p "/jsc-code:target --run --yes"` |
|
||||||
|
| `opencode` | `opencode run "執行專案根目錄 TARGET.md 的未完成項目,完成後分類提交、push develop 並對預設分支發 PR"` |
|
||||||
|
| `copilot` | `copilot -p "執行專案根目錄 TARGET.md 的未完成項目,完成後分類提交、push develop 並對預設分支發 PR"` |
|
||||||
|
|
||||||
|
> **排程是非互動環境**:助理若跳出工具權限詢問會直接卡住,排程等於沒跑。建立排程前要提醒使用者**先在該專案預先授權**(例如 Claude Code 於專案設定的 `permissions.allow` 列出所需工具,或在指令上加該助理的非互動旗標)。這牽涉安全取捨,**由使用者決定,不代為加上略過權限的旗標**。
|
||||||
|
|
||||||
|
### S3. 建立/更新排程(`--schedule on`)
|
||||||
|
|
||||||
|
**crontab**(標記寫在行尾,一筆條目就是一行,安裝與移除都靠它比對):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
marker="# jsc-code:target ${proj}"
|
||||||
|
entry="0 0 * * * cd '${proj}' && <headless 指令> >> '${log}' 2>&1 ${marker}"
|
||||||
|
|
||||||
|
mkdir -p "$(dirname "${log}")"
|
||||||
|
tmp="$(mktemp)"
|
||||||
|
crontab -l 2>/dev/null | grep -vF "${marker}" > "${tmp}" # 先移除同專案的舊條目(更新用)
|
||||||
|
printf '%s\n' "${entry}" >> "${tmp}"
|
||||||
|
crontab "${tmp}"
|
||||||
|
rm -f "${tmp}"
|
||||||
|
|
||||||
|
crontab -l | grep -F "${marker}" # 驗證確實寫進去了
|
||||||
|
```
|
||||||
|
|
||||||
|
- `crontab -l` 在「完全沒有排程」時會回非 0 並印錯誤,所以要 `2>/dev/null`;**不可因此把整份 crontab 當成空的覆寫**——先確認 `crontab -l` 的失敗是「沒有排程」而不是權限問題。
|
||||||
|
- 指令中若出現 `%`,crontab 會把它當換行,必須寫成 `\%`。
|
||||||
|
- 條目一律用**絕對路徑**(cron 的 `PATH` 很精簡);若 `command -v <cli>` 得到的不是系統路徑,把 CLI 也寫成絕對路徑。
|
||||||
|
|
||||||
|
**schtasks**(Windows):
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
$task = "jsc-code-target-<專案名>" # 專案名重複時附加路徑短碼,確保唯一
|
||||||
|
schtasks /Create /TN "$task" /SC DAILY /ST 00:00 /F `
|
||||||
|
/TR "cmd /c cd /d ""<專案絕對路徑>"" && <headless 指令> >> ""<log 絕對路徑>"" 2>&1"
|
||||||
|
schtasks /Query /TN "$task" # 驗證
|
||||||
|
```
|
||||||
|
|
||||||
|
`/F` 只覆蓋**同名**任務(即本 skill 自己那筆),不影響其他排程。
|
||||||
|
|
||||||
|
### S4. 移除排程(`--schedule off`)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
tmp="$(mktemp)"
|
||||||
|
crontab -l 2>/dev/null | grep -vF "# jsc-code:target ${proj}" > "${tmp}"
|
||||||
|
crontab "${tmp}"
|
||||||
|
rm -f "${tmp}"
|
||||||
|
crontab -l 2>/dev/null | grep -F "# jsc-code:target ${proj}" || echo "已移除"
|
||||||
|
```
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
schtasks /Delete /TN "jsc-code-target-<專案名>" /F
|
||||||
|
```
|
||||||
|
|
||||||
|
- 找不到條目 → 回報「本來就沒有排程」,視為成功,不報錯。
|
||||||
|
- **只刪自己標記的那一筆**;其餘 crontab 內容原樣寫回。`TARGET.md`、log 檔、git 分支都不刪。
|
||||||
|
|
||||||
|
### S5. 確認排程服務真的在跑(`--schedule on` 後必做)
|
||||||
|
|
||||||
|
排程條目寫進去 ≠ 會被執行。安裝後檢查:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pgrep -x cron >/dev/null || pgrep -x crond >/dev/null || echo "cron 服務未執行"
|
||||||
|
```
|
||||||
|
|
||||||
|
- **WSL 特別注意**:WSL 預設不啟動 cron,需要 `sudo service cron start`,且**重開 WSL 後要再啟動一次**(可寫進 `/etc/wsl.conf` 的 `boot.command` 或啟動腳本)。偵測到未執行時**明確告知使用者這件事**,不要只回報「排程已建立」。
|
||||||
|
- Windows:`schtasks /Query /TN "<任務名>"` 能查到即可。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 A:Git 同步(`--run`)
|
||||||
|
|
||||||
|
### A1. 盤點狀態
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd "<專案根目錄>"
|
||||||
|
git rev-parse --show-toplevel
|
||||||
|
git status --porcelain
|
||||||
|
git rev-parse --abbrev-ref HEAD
|
||||||
|
```
|
||||||
|
|
||||||
|
- **工作區有未提交變更** → **停止**並回報(排程情境寫入 log)。理由:本 skill 結尾會分類提交所有變更,混入使用者未完成的工作會把它一起提交上去。依 `/jsc-shared:spec-git-safety`,**不得** stash、`reset --hard` 或 `clean` 來清場。
|
||||||
|
- **detached HEAD** → 停止並回報。
|
||||||
|
|
||||||
|
### A2. Fetch 與判定遠端預設分支
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git fetch --all --prune
|
||||||
|
git symbolic-ref --quiet refs/remotes/origin/HEAD # → refs/remotes/origin/<預設分支>
|
||||||
|
```
|
||||||
|
|
||||||
|
取不到時退而用 `git remote show origin`(找 `HEAD branch:` 那行);`--base` 有帶則直接採用。兩者都不成立 → 停止並詢問,不臆測 `master`/`main`。
|
||||||
|
|
||||||
|
### A3. 切到 `develop`(不存在就從預設分支建立)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
if git rev-parse --verify --quiet origin/develop >/dev/null; then
|
||||||
|
git switch develop 2>/dev/null || git switch -c develop --track origin/develop
|
||||||
|
git pull --ff-only
|
||||||
|
else
|
||||||
|
git switch -c develop "origin/<預設分支>" # 遠端沒有 develop → 從預設分支開一條新的
|
||||||
|
fi
|
||||||
|
```
|
||||||
|
|
||||||
|
- `pull --ff-only` 失敗(分岔)→ 停止並回報,交由使用者處理,不做 merge/rebase 猜測。
|
||||||
|
- 本地已有 `develop` 但遠端沒有 → 沿用本地那條,**不覆蓋、不重建**;並在回報中說明它還沒推上遠端。
|
||||||
|
- 新建 develop 屬不可忽略的狀態變更,必須在回報與 log 中明講「遠端沒有 develop,已從 `<預設分支>` 建立」。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 B:讀 `TARGET.md` 並盤點待辦
|
||||||
|
|
||||||
|
1. 讀 `<專案根目錄>/TARGET.md`(UTF-8)。檔案不存在 → 回報「無 TARGET.md,無待辦」,**正常結束**(不進入 C~F、不 commit、不發 PR)。
|
||||||
|
2. 解析出所有 `- [ ]` 未勾選項目(含子項目的從屬關係),依**檔案由上而下**的順序排定執行順序。
|
||||||
|
3. 全部都是 `- [x]` → 回報「TARGET.md 已全部完成」,正常結束。
|
||||||
|
4. 輸出待辦清單表,除非使用者要求確認,否則直接進入階段 C:
|
||||||
|
|
||||||
|
| # | 項目 | 子項目數 | 備註 |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 C:逐項實作並回寫 `TARGET.md`
|
||||||
|
|
||||||
|
依 B 的順序,**一次做一項,做完一項就回寫 `TARGET.md`**(中途失敗時已完成的進度不會遺失):
|
||||||
|
|
||||||
|
1. 讀懂該項目要什麼;必要時讀相關程式碼與文件確認脈絡。
|
||||||
|
2. **語意不明、範圍不清、或牽涉設計取捨無法安全決定** → 不硬做。保持未勾選、補上 `> ⏭️ 待人工處理:<原因>`,繼續下一項。
|
||||||
|
3. 實作最小且合理的變更;能驗證的就驗證(該專案既有的 build/test 指令)。驗證失敗且無法安全修正 → 比照第 2 點標記待人工處理,並**還原**該項目造成的變更,不留半成品。
|
||||||
|
4. 完成 → 把該行改成 `- [x]` 並於行尾補 `(<yyyy/MM/dd HH:mm:ss> 完成)`;有子項目則子項目全部完成後才勾選上層。
|
||||||
|
5. 每項結束記錄結果(✅ 完成 / ⏭️ 待人工處理+原因),供階段 G 總結。
|
||||||
|
|
||||||
|
`TARGET.md` 一律以 UTF-8(不含 BOM)寫回,結尾保留一個換行;**只改動勾選狀態與完成時間/待人工註記**,其餘內容原樣保留。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 D:分類提交
|
||||||
|
|
||||||
|
1. 盤點**所有**變更(含未追蹤檔):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git status --porcelain=v1 -uall
|
||||||
|
```
|
||||||
|
|
||||||
|
2. 依實際異動內容歸入 conventional commit 類型(`feat`/`fix`/`docs`/`style`/`refactor`/`perf`/`test`/`chore`/`revert`),**每個 type 各一個 commit**。
|
||||||
|
3. commit 訊息格式 `type(範圍): 一句總結`,**括號內是實際異動的功能/模組名**,不是重述 type:
|
||||||
|
- ✅ `feat(使用者服務): 補上帳號建立與停用的單元測試`、`docs(README): 更新安裝章節的 CLI 指令`
|
||||||
|
- ❌ `feat(新增功能)`、`docs(文件)`
|
||||||
|
- `TARGET.md` 本身的勾選更新歸 `chore`,訊息用 `chore(TARGET): 更新每日待辦完成狀態`。
|
||||||
|
4. 逐組精準 `git add -- <該組檔案...>` 後 commit,不用 `git add -A` 一次混提。
|
||||||
|
5. 無任何變更(例如所有項目都待人工處理,只有 `TARGET.md` 的註記異動)→ 仍照常提交 `TARGET.md` 的異動;連 `TARGET.md` 都沒變則跳過 D、E、F,直接進入總結。
|
||||||
|
|
||||||
|
> 分類與訊息規則與 `/jsc-code:review-resolve` 階段 C 一致,細節可參照該 skill。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 E:Push `develop`
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git log --oneline "origin/develop..develop" 2>/dev/null # 領先遠端的 commit;遠端無 develop 時視為全部要推
|
||||||
|
```
|
||||||
|
|
||||||
|
無 commit 可推 → 跳過 push,直接進入階段 F(既有遠端分支仍可開 PR)。否則依序嘗試,前者失敗才換下一個:
|
||||||
|
|
||||||
|
1. **認證管理器**:`git push -u origin develop`
|
||||||
|
2. **token**:從環境變數帶入,指令與輸出**全程遮蔽 token、不寫進 remote 設定**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git push "https://oauth2:${GITEA_TOKEN}@<host>/<owner>/<repo>.git" develop
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **都失敗** → 停止並回報失敗原因(先遮蔽 token)。排程情境寫入 log,等使用者處理,不猜測其他憑證。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 階段 F:對預設分支發 PR(`--no-pr` 時略過)
|
||||||
|
|
||||||
|
### F1. 目標分支
|
||||||
|
|
||||||
|
`--base` 有帶則用它,否則用 A2 判定出的**遠端預設分支**。若預設分支就是 `develop`(等於 head=base)→ 不開 PR,回報原因即可。
|
||||||
|
|
||||||
|
### F2. 先查有沒有現成的 open PR(每天跑,不可重複開)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -sS -H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
"https://<host>/api/v1/repos/<owner>/<repo>/pulls?state=open&base=<預設分支>"
|
||||||
|
```
|
||||||
|
|
||||||
|
已存在 `head=develop` → `base=<預設分支>` 的 open PR → **沿用它**(今天新推的 commit 會自動出現在該 PR),回報既有 PR 連結,並視情況在該 PR 補一則今日進度留言;**不重複建立**。
|
||||||
|
|
||||||
|
### F3. 建立 PR
|
||||||
|
|
||||||
|
repo 座標由 `git remote get-url origin` 解析(host/owner/repo)。body 以 UTF-8 JSON 檔帶入,換行用實際換行、不可送出字面 `\n`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -sS -X POST \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
"https://<host>/api/v1/repos/<owner>/<repo>/pulls" \
|
||||||
|
--data @body.json
|
||||||
|
```
|
||||||
|
|
||||||
|
- **標題**:`chore(TARGET): <yyyy/MM/dd> 每日待辦`(有明確主軸時可改成該主軸的一句總結)。
|
||||||
|
- **描述**:本次完成的項目清單(✅/⏭️ 各自列出+待人工處理原因)、變更摘要與影響範圍、本次的 commit 一覽。
|
||||||
|
- 失敗 → 回報 API 錯誤訊息(先遮蔽 token)。常見原因:目標分支不存在、已有相同 head→base 的 PR(回到 F2 沿用)、token 權限不足。
|
||||||
|
|
||||||
|
### F4. 收尾
|
||||||
|
|
||||||
|
push/API 過程可能讓 token 殘留在對話內文;**互動情境**完成後提醒使用者清除對話(Claude Code 用 `/clear`)。排程情境只寫 log,不輸出 token。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 總結
|
||||||
|
|
||||||
|
執行後輸出(排程情境同時以 `[時間][階段][等級]: 訊息` 寫入 log):
|
||||||
|
|
||||||
|
| 模式 | 要回報的內容 |
|
||||||
|
| --- | --- |
|
||||||
|
| `--schedule on` | 用了哪種機制(crontab/schtasks)、條目內容、log 路徑、排程服務是否在跑(WSL 未啟動 cron 要明講)、下次執行時間 |
|
||||||
|
| `--schedule off` | 移除了哪一筆、其餘排程未受影響 |
|
||||||
|
| `--run` | 待辦總數/✅ 完成 N 項/⏭️ 待人工處理 K 項(逐項原因)、develop 是新建還是既有、建立了哪幾個 commit、push 結果與方式、PR 連結(新建或沿用既有)、或為何略過 |
|
||||||
|
| 無參數 | 排程狀態+下次執行時間、`TARGET.md` 是否存在與剩餘未完成項目數 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 呼叫方式
|
||||||
|
|
||||||
|
| 助理 | 呼叫 |
|
||||||
|
| --- | --- |
|
||||||
|
| Claude Code / Antigravity | `/jsc-code:target --schedule on`、`/jsc-code:target --schedule off`、`/jsc-code:target --run --yes`、`/jsc-code:target --schedule on --run --project-dir ~/work/app` |
|
||||||
|
| Codex | `$target --schedule on`、`$target --run --yes`,或用 `/skills` 選單 |
|
||||||
|
| OpenCode | 描述需求(如「幫我把這個專案的 TARGET.md 排成每天 00:00 自動執行,做完分類提交、push develop 並對預設分支發 PR」)自動觸發 |
|
||||||
Reference in New Issue
Block a user