Compare commits
3
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
fc39c1254d | ||
|
|
6e22907b0e | ||
|
|
0b464c5cdf |
@@ -235,19 +235,19 @@ rm -rf ~/.config/opencode/skills/{code-review,code-review-archive,code-review-re
|
||||
|
||||
### `code-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`;(C) 產生 `entrypoint.sh`,**啟動 node 前先輸出 action 名稱/用途/更新時間**(Asia/Taipei `yyyy/MM/dd HH:mm:ss`)再 `exec node`;(D) 依**六步流程**(參數處理 → 安裝套件 → 複製檔案 → 執行程序 → 縮小映像檔 → 設定入口)產生**使用最新 node 版本**的 `Dockerfile`,**每步內容依主程式(`src/`)實作量身決定**(先盤點相依/是否需 build/OS 層相依/入口檔再填對應步驟,用不到的不硬塞),預設 build 基底 `node:latest`、runtime `node:slim`、**多階段建置縮小映像**,`ENTRYPOINT` 指向 `entrypoint.sh`;(E) 對整個專案**完整執行 `/jsc:doc-funcs`**(function 文件、`entrypoint.sh`/`Dockerfile` 逐行註解、重建 README)。
|
||||
把 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 各檔的「更新時間」於最終階段(doc-funcs 完成後)**統一同步為同一時間戳**。
|
||||
|
||||
參數:`[--action-dir <action 根目錄>] [--node-version <node tag>] [--main <主程式檔>] [--yes]`(根目錄預設目前工作目錄;node 版本預設最新;主程式自動判斷;`--yes` 略過一般確認,但主程式改寫與 doc-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**:`$code-action-docker`,或 `$code-action-docker --action-dir ~/work/my-action`,或用 `/skills` 選單
|
||||
- **OpenCode**:描述需求(如「把這個 action 主程式改成 node、所有 js 收進 src/,產生會先輸出 action 名稱/用途/更新時間再啟動 node 的 entrypoint.sh、用最新 node 版本的 Dockerfile,最後跑 doc-funcs 補文件並重建 README」)自動觸發
|
||||
- **OpenCode**:描述需求(如「把這個 action 主程式改成 node、主程式相關 js 收進 src/,產生會先輸出 action 名稱/用途/更新時間再啟動 node 的 entrypoint.sh、用最新 LTS node 版本的 Dockerfile,最後跑 doc-funcs 補文件並重建 README」)自動觸發
|
||||
|
||||
### `code-action-composite`
|
||||
|
||||
把 Gitea/GitHub「composite action」專案標準化,再串接文件化流程。四階段:(A) 找出 action 專案、讀 `action.yml`/`action.yaml` 的 `name`/`description`/`runs`、判斷是否為 composite;(B) **已是 composite 則保留既有 `steps`**,非 composite(JS/Docker)則**保守確認後對齊**為 composite(高風險先以 AskUserQuestion 確認,保留 `inputs`/`outputs` 契約;Docker 行為無法等價塞入時標「需人工確認」並建議改用 `code-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「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 行為無法等價塞入時標「需人工確認」並建議改用 `code-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 各檔的「更新時間」於最終階段(doc-funcs 完成後)**統一同步為同一時間戳**。
|
||||
|
||||
參數:`[--action-dir <action 根目錄>] [--manifest <action.yml 路徑>] [--yes]`(根目錄預設目前工作目錄;manifest 自動尋找 `action.yml`/`action.yaml`;`--yes` 略過一般確認,但「非 composite 需對齊」與 doc-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**:`$code-action-composite`,或 `$code-action-composite --action-dir ~/work/my-action`,或用 `/skills` 選單
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
---
|
||||
name: code-action-composite
|
||||
description: 將 Gitea/GitHub「composite action」專案標準化並串接文件化流程:(1) 確認 action 為 composite(`runs.using: composite`),非 composite 則保守確認後對齊;(2) 在 `runs.steps` 最前面注入啟動橫幅 step,輸出 action 名稱/用途/更新時間(Asia/Taipei `yyyy/MM/dd HH:mm:ss`),並於 `action.yml` 開頭補用途/更新時間註解區塊;(3) 最後完整執行 `/jsc:doc-funcs` 處理流程(function 文件、指令檔逐行註解、重建 README)。當使用者說整理 composite action、把 action 標準化為 composite、讓 composite action 啟動時印名稱/用途/更新時間、對 composite action 補文件,或提到 code-action-composite 時觸發。不適用於:Docker 容器 action(用 code-action-docker)、非 action 專案、或不需文件化的一般 repo。
|
||||
argument-hint: "[--action-dir <action 根目錄>] [--manifest <action.yml 路徑>] [--yes]"
|
||||
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 補文件,或提到 code-action-composite 時觸發。不適用於:Docker 容器 action(用 code-action-docker)、或不需 action 化/文件化的一般 repo。
|
||||
argument-hint: "[--action-dir <action 根目錄>] [--manifest <action.yml 路徑>]"
|
||||
---
|
||||
|
||||
# code-action-composite — composite action 標準化+文件化
|
||||
|
||||
四階段 skill:先做**前置設定與偵測**(找出 action 專案、讀取名稱/用途、判斷是否為 composite),再**確認/對齊為 composite action**,接著在 `runs.steps` 最前面**注入會輸出 action 名稱/用途/更新時間的啟動橫幅 step**,最後**完整執行 `/jsc:doc-funcs` 處理流程**替整個專案補文件並重建 README。
|
||||
四階段 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 |
|
||||
| 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. 串接 doc-funcs | 對整個 action 專案完整執行 `/jsc:doc-funcs` 流程(function 文件、指令檔逐行註解、重建 README) |
|
||||
@@ -23,18 +23,35 @@ argument-hint: "[--action-dir <action 根目錄>] [--manifest <action.yml 路徑
|
||||
- **編碼無亂碼**:凡輸出含繁體中文、全形標點、emoji,一律 **UTF-8(不含 BOM)**,不得出現問號方框或錯碼。產生/覆寫的 `action.yml`/`action.yaml`、被引用腳本、`README.md` 同樣需 UTF-8(不含 BOM)。
|
||||
- **自動執行原則**:除非使用者明確要求先確認,或遇到不可忽略的必要決策,否則各階段只需輸出簡短計畫/進度後直接執行到完成。**一定會中斷詢問的點**:階段 B 主 action「非 composite 需對齊」時(破壞性,須先確認),以及階段 D 由 `/jsc:doc-funcs` 自身的「如何實作」詢問。
|
||||
- **不破壞既有工作**:改寫 `action.yml`/搬移或改寫被引用腳本前,若工作區有未提交變更,先提醒使用者建議先 commit/備份;**絕不** `reset --hard`/`checkout -f`/`clean`,也不刪除使用者既有原始碼。移動檔案優先用 `git mv` 以保留歷史。
|
||||
- **保留行為**:對齊 composite 與注入橫幅 step 只「補強」既有流程,不得擅自改變既有 `steps` 的執行順序、輸入(`inputs`)/輸出(`outputs`)契約或副作用;任何無法可靠等價推論的改動一律不做,並以註解或回報標註「需人工確認」。
|
||||
- **保留行為**:對齊 composite 與注入橫幅 step 只「補強」既有流程,不得擅自改變既有 `steps` 的執行順序、輸入(`inputs`)/輸出(`outputs`)契約或副作用;任何無法可靠等價推論的改動一律不做,並以註解或回報標註「需人工確認」。新增 `input` 僅限依「參數來源優先序」經使用者同意後為之。
|
||||
- **不擴及無關檔案**:本 skill 只動 action 專案根目錄內的:`action.yml`/`action.yaml`、其 `steps` 直接引用的內嵌腳本(如 `*.sh`/`*.ps1`),以及階段 D 由 doc-funcs 流程處理的目標;排除 `node_modules`/`.git`/`.docs`/`bin`/`obj`/第三方依賴。
|
||||
|
||||
---
|
||||
|
||||
## 參數來源優先序(開發中需要新參數時)
|
||||
|
||||
從零建立(A1a)、對齊 composite(階段 B)、注入橫幅 step(階段 C)或補強被引用腳本的過程中,若需要新的參數值,依下列順序處理,**前一項可取得就不往下**:
|
||||
|
||||
1. **`${{ gitea.* }}`/`${{ github.* }}` context**:在 Gitea composite action 的 `runs.steps` 內**可直接使用**(Gitea 中 `gitea` 與 `github` context 互為別名)。常用如 `github.repository`、`github.ref_name`、`github.server_url`、`github.token`、`github.event.*`。為同時相容 GitHub Actions,composite action 內建議寫 `github.*`(Gitea 亦支援);確定只跑 Gitea 的專案可用 `gitea.*`。`run` 腳本內可改讀同源的執行期環境變數(`$GITHUB_REPOSITORY`、`$GITHUB_SERVER_URL`、`$GITHUB_REF_NAME` 等)。
|
||||
2. **context 無法取得 → 詢問使用者新增 `inputs`**:以 `AskUserQuestion` 詢問使用者是否新增對應 `input`(名稱/description/`required`/`default`),經同意後於 `inputs` 宣告並在 step 內以 `${{ inputs.<name> }}` 取用;未經同意**不得**擅自更動 `inputs`/`outputs` 契約。
|
||||
|
||||
**secrets/vars 一律視為不可用,不列入優先序**:`${{ secrets.* }}`/`${{ vars.* }}` context 在 composite action 的 `action.yml` 內於 GitHub 為**官方明文不可用**(composite action 取不到 `secrets`/`vars` context,`inputs` 的 `default` 也不能引用);Gitea act_runner 未嚴格檢查 context 可用性、行為無保證。為求兩邊相容,本 skill 一律視為不可用——參數值本質上屬 secrets/vars 者,直接依第 2 項宣告為 `input`,回報時附上呼叫端 workflow 的傳入寫法:
|
||||
|
||||
```yaml
|
||||
- uses: <owner>/<action>@<ref>
|
||||
with:
|
||||
token: ${{ secrets.MY_TOKEN }} # secrets 由呼叫端 workflow 傳入
|
||||
registry: ${{ vars.MY_REGISTRY }} # vars 亦同
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 參數
|
||||
|
||||
格式:`[--action-dir <action 根目錄>] [--manifest <action.yml 路徑>] [--yes]`
|
||||
格式:`[--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`。
|
||||
- `--yes`:盡量不中斷。即使帶此參數,「非 composite 需對齊」與 doc-funcs 的「如何實作」仍會詢問。
|
||||
|
||||
---
|
||||
|
||||
@@ -44,7 +61,17 @@ argument-hint: "[--action-dir <action 根目錄>] [--manifest <action.yml 路徑
|
||||
|
||||
- 帶 `--action-dir` → 採用(展開 `~`);省略 → 用目前工作目錄。
|
||||
- manifest:帶 `--manifest` → 採用;否則於根目錄找 `action.yml`,再退而 `action.yaml`。
|
||||
- **找不到** action manifest → 回報「此目錄不是 action 專案(缺 action.yml/action.yaml)」並詢問正確路徑,**不臆測**、不在非 action 專案上動工。
|
||||
- **找不到** 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 名稱與用途
|
||||
|
||||
@@ -55,7 +82,7 @@ argument-hint: "[--action-dir <action 根目錄>] [--manifest <action.yml 路徑
|
||||
- `runs`:目前的執行設定(`using`、`steps`、`main`、`image`、`entrypoint` 等)。
|
||||
- `inputs`/`outputs`:對外契約(後續不得破壞)。
|
||||
|
||||
若 `name`/`description` 缺漏,回報並請使用者補;無法取得時於後續輸出以「(未提供)」保守標示,**不編造**。
|
||||
若 `name`/`description` 缺漏,回報缺漏並**詢問一次**;使用者跳過或無法提供時,於後續輸出以「(未提供)」標示續行,**不編造**。
|
||||
|
||||
### A3. 判斷是否為 composite
|
||||
|
||||
@@ -66,7 +93,7 @@ argument-hint: "[--action-dir <action 根目錄>] [--manifest <action.yml 路徑
|
||||
|
||||
輸出偵測結果(action 名稱、用途、`runs.using`、是否為 composite、既有 step 數量),再進入階段 B。
|
||||
|
||||
> 若偵測為 **Docker 容器 action**,且使用者本意是容器化而非 composite,提醒可改用 `/jsc:code-action-docker`,再依使用者裁示決定是否續行。
|
||||
> 若偵測為 **Docker 容器 action**,此處**僅輸出偵測結果**並提醒可改用 `/jsc:code-action-docker`,**不詢問**;是否對齊/維持原樣/改用 code-action-docker 的決策,統一由階段 B2 的一次 `AskUserQuestion` 收斂。
|
||||
|
||||
---
|
||||
|
||||
@@ -75,26 +102,41 @@ argument-hint: "[--action-dir <action 根目錄>] [--manifest <action.yml 路徑
|
||||
### B1. 已是 composite
|
||||
|
||||
- 確認 `runs.using: composite` 與既有 `runs.steps`,**不更動既有 steps 的順序與邏輯**,直接進入階段 C。
|
||||
- 順手檢查 step 的必要欄位(`run` step 須有 `shell`;`uses` step 的引用是否存在),有疑慮以回報標註,不擅改。
|
||||
- 順手檢查 step 的必要欄位:`run` step 缺 `shell` 屬**原檔錯誤**(GitHub/Gitea 都會拒跑),**允許補上 `shell: bash`** 並在回報中列出;其他疑慮(如 `uses` step 的引用是否存在)以回報標註、不擅改。
|
||||
|
||||
### B2. 非 composite(需對齊)
|
||||
|
||||
這是**破壞性高風險決策**:先以 `AskUserQuestion` 向使用者確認,選項至少含「對齊為 composite」「維持原樣只做文件化(略過對齊)」「改用 code-action-docker」「其他」。經確認「對齊為 composite」後才改寫:
|
||||
|
||||
- 將 `runs` 保守對齊為 composite,把原執行入口轉為 composite step:
|
||||
- 原 JS action(`runs.using: node*`,`runs.main: <x>.js`)→ 轉為一個 `run` step,於 step 內以 `node <x>.js` 執行(`shell: bash`),保留 `inputs`/`outputs` 與環境變數(`INPUT_*`)契約。
|
||||
- 原 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`。
|
||||
|
||||
對齊後的 `runs` 形如:
|
||||
對齊後(含 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
|
||||
```
|
||||
|
||||
@@ -104,7 +146,7 @@ runs:
|
||||
|
||||
在 `runs.steps` **最前面**插入(或更新)一個輸出橫幅的 step,讓 composite action 一啟動就**輸出 action 名稱、用途、更新時間**;並於 `action.yml` 開頭補用途/更新時間註解區塊。
|
||||
|
||||
- **更新時間**為產生此檔當下的時間戳,使用台灣時區(Asia/Taipei)並固定為 `yyyy/MM/dd HH:mm:ss`(可用 `TZ='Asia/Taipei' date +'%Y/%m/%d %H:%M:%S'` 取得),**寫成檔內固定字串**(非執行期動態時間)。
|
||||
- **更新時間**語意為「本檔最後由本 skill 產生/更新的時間」,使用台灣時區(Asia/Taipei)並固定為 `yyyy/MM/dd HH:mm:ss`(可用 `TZ='Asia/Taipei' date +'%Y/%m/%d %H:%M:%S'` 取得),**寫成檔內固定字串**(非執行期動態時間)。本階段先寫入暫定時間戳,**階段 D 完成後會統一同步各處時間戳**(見階段 D)。
|
||||
- 名稱/用途取自階段 A2 的 `action.yml`(缺漏時以「(未提供)」標示)。
|
||||
- 橫幅 step 須有可辨識的 `name`(如 `顯示 action 資訊`)與 `shell: bash`;其後緊接既有/對齊後的 steps,**不更動既有 steps**。
|
||||
- 若已存在本 skill 先前插入的橫幅 step(依 `name` 辨識),則**更新**其內容與更新時間,不重複插入。
|
||||
@@ -142,10 +184,12 @@ runs:
|
||||
|
||||
標準化完成後,對**整個 action 專案**完整執行 `/jsc:doc-funcs` 流程,替程式碼與指令檔補文件並重建 README:
|
||||
|
||||
- **前置檢查**:先確認 doc-funcs skill 可用(`/jsc:doc-funcs`);不可用則回報並**略過本階段**,於總結標註「未文件化」。
|
||||
- 以階段 A1 的 action 根目錄為目標,執行 `doc-funcs` skill 的完整流程(判斷語言 → 掃描 function 與指令檔 → 建立 `.docs/` 草稿 → 草稿品質檢查 → 詢問使用者如何實作 → 依選擇寫回 → 保守優化 → 重建 README → 錨點檢查 → 清理草稿 → 建置/語法驗證)。
|
||||
- doc-funcs 會把 `action.yml`/`action.yaml` 視為 CI/部署設定檔處理:補齊「用途+更新日期同一註解區塊」與逐行註解;`steps` 內引用的腳本(`*.sh`/`*.ps1` 等)逐行註解;專案內各 function 補文件註解。
|
||||
- doc-funcs 的「如何實作」詢問(全部一起/逐個/其他)由使用者於該流程內裁示,本 skill 不代為決定。
|
||||
- 完成後依 doc-funcs 規範重建根目錄 `README.md`(含台灣時區更新時間、專案列表、功能列表、使用範例)。
|
||||
- **統一時間戳**:doc-funcs 全部完成後,以完成當下的 Asia/Taipei 時間(`yyyy/MM/dd HH:mm:ss`)回頭同步橫幅 step 內文、`action.yml` 開頭註解區塊與 README 的更新時間,**確保各處時間戳一致**。
|
||||
|
||||
> 銜接方式:在本 skill 環境中以 `/jsc:doc-funcs`(或 Skill 工具)啟動 doc-funcs 流程;若該流程需參數,沿用本 skill 的 action 根目錄為目標專案。
|
||||
|
||||
@@ -155,8 +199,8 @@ runs:
|
||||
|
||||
各階段執行後輸出:
|
||||
|
||||
- **階段 A**:action 根目錄、manifest 路徑、action 名稱/用途、`runs.using`、是否為 composite、既有 step 數量。
|
||||
- **階段 B**:是否對齊為 composite(及對齊摘要與「需人工確認」清單),或維持原樣的理由。
|
||||
- **階段 A**:action 根目錄、manifest 路徑、action 名稱/用途、`runs.using`、是否為 composite、既有 step 數量;若走 A1a 從零建立,列出問答收集結果(名稱/輸入輸出/目標)。
|
||||
- **階段 B**:是否對齊為 composite(及對齊摘要與「需人工確認」清單),或維持原樣的理由;依「參數來源優先序」新增的 `inputs` 清單與呼叫端傳入寫法(若有)。
|
||||
- **階段 C**:橫幅 step 的輸出內容(名稱/用途/更新時間)與插入位置,並確認既有 steps、`inputs`/`outputs` 未被破壞。
|
||||
- **階段 D**:doc-funcs 流程的處理結果(文件化的 function 與指令檔、重建的 README)。
|
||||
- 列出本次新增/變更的檔案與其相對路徑,並提醒使用者於提交前確認 `action.yml` 可正常解析、composite action 能正確啟動並輸出橫幅。
|
||||
@@ -165,7 +209,7 @@ runs:
|
||||
|
||||
## 呼叫方式
|
||||
|
||||
格式:`[--action-dir <action 根目錄>] [--manifest <action.yml 路徑>] [--yes]` — 全部可省略(根目錄預設目前工作目錄;manifest 自動尋找)。
|
||||
格式:`[--action-dir <action 根目錄>] [--manifest <action.yml 路徑>]` — 全部可省略(根目錄預設目前工作目錄;manifest 自動尋找)。
|
||||
|
||||
| 助理 | 呼叫 |
|
||||
| --- | --- |
|
||||
|
||||
@@ -1,19 +1,19 @@
|
||||
---
|
||||
name: code-action-docker
|
||||
description: 將 Gitea/GitHub「Docker 容器 action」專案標準化為 Node 主程式+容器化,並串接文件化流程:(1) 檢查 action 主程式是否為 Node,否則保守改寫為 Node,且所有 `.js` 檔一律集中到 `src/` 資料夾;(2) 產生 `entrypoint.sh`,啟動前先輸出 action 名稱/用途/更新時間,再執行 node 主程式;(3) 產生使用最新 node 版本的 `Dockerfile`;(4) 最後完整執行 `/jsc:doc-funcs` 處理流程(function 文件、指令檔逐行註解、重建 README)。當使用者說把 action 改成 docker/node、容器化 action、action 主程式 node 化、把 js 收進 src、產 entrypoint.sh/Dockerfile 給 action,或提到 code-action-docker 時觸發。不適用於:非 action 專案、純前端打包、或不需容器化的一般 repo。
|
||||
argument-hint: "[--action-dir <action 根目錄>] [--node-version <node tag>] [--main <主程式檔>] [--yes]"
|
||||
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 參數來源,或提到 code-action-docker 時觸發。不適用於:composite action(用 code-action-composite)、純前端打包、或不需容器化的一般 repo。
|
||||
argument-hint: "[--action-dir <action 根目錄>] [--node-version <node tag>] [--main <主程式檔>]"
|
||||
---
|
||||
|
||||
# code-action-docker — action 容器化(Node 主程式)+文件化
|
||||
|
||||
五階段 skill:先做**前置設定與偵測**(找出 action 專案、讀取名稱/用途、判斷主程式語言),再把**主程式 Node 化並將所有 `.js` 收進 `src/`**,接著產生**啟動前先輸出 action 名稱/用途/更新時間的 `entrypoint.sh`**,然後產生**使用最新 node 版本的 `Dockerfile`**(並對齊 `action.yml` 的 docker 設定),最後**完整執行 `/jsc:doc-funcs` 處理流程**替整個專案補文件並重建 README。
|
||||
五階段 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` → 判斷目前主程式與語言 |
|
||||
| B. 主程式 Node 化 | 主程式非 Node 則**保守改寫**為 Node(高風險,先確認)→ 所有 `.js` 集中到 `src/`,更新所有引用、`package.json`、`action.yml` |
|
||||
| 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 | 依六步流程(參數處理 → 安裝套件 → 複製檔案 → 執行程序 → 縮小映像檔 → 設定入口)產生使用**最新 node 版本**的 `Dockerfile`,多階段建置縮小映像、`ENTRYPOINT` 指向 `entrypoint.sh` |
|
||||
| D. Dockerfile | 依六步流程(參數處理 → 安裝套件 → 複製檔案 → 執行程序 → 縮小映像檔 → 設定入口)產生使用**最新 LTS node 版本**的 `Dockerfile`,多階段建置縮小映像、`ENTRYPOINT` 指向 `entrypoint.sh` |
|
||||
| E. 串接 doc-funcs | 對整個 action 專案完整執行 `/jsc:doc-funcs` 流程(function 文件、指令檔逐行註解、重建 README) |
|
||||
|
||||
---
|
||||
@@ -24,19 +24,36 @@ argument-hint: "[--action-dir <action 根目錄>] [--node-version <node tag>] [-
|
||||
- **編碼無亂碼**:凡輸出含繁體中文、全形標點、emoji,一律 **UTF-8(不含 BOM)**,不得出現問號方框或錯碼。產生/覆寫的 `entrypoint.sh`、`Dockerfile`、`action.yml`、`README.md` 同樣需 UTF-8(不含 BOM)。
|
||||
- **自動執行原則**:除非使用者明確要求先確認,或遇到不可忽略的必要決策,否則各階段只需輸出簡短計畫/進度後直接執行到完成。**一定會中斷詢問的點**:階段 B 主程式「非 Node 需改寫」時(破壞性,須先確認),以及階段 E 由 `/jsc:doc-funcs` 自身的「如何實作」詢問。
|
||||
- **不破壞既有工作**:移動 `.js`、改寫主程式、覆寫 `entrypoint.sh`/`Dockerfile`/`action.yml` 前,若工作區有未提交變更,先提醒使用者建議先 commit/備份;**絕不** `reset --hard`/`checkout -f`/`clean`,也不刪除使用者既有原始碼。移動檔案優先用 `git mv` 以保留歷史。
|
||||
- **保留行為**:Node 化只「翻譯」既有邏輯,不得擅自改變對外行為、輸入輸出契約或副作用;任何無法可靠等價推論的改動一律不做,並以註解或回報標註「需人工確認」。
|
||||
- **不擴及無關檔案**:本 skill 只動 action 專案根目錄內的:主程式、`.js`(搬移到 `src/`)、`package.json`、`action.yml`/`action.yaml`、`entrypoint.sh`、`Dockerfile`,以及階段 E 由 doc-funcs 流程處理的目標;排除 `node_modules`/`.git`/`.docs`/`bin`/`obj`/第三方依賴。
|
||||
- **保留行為**:Node 化只「翻譯」既有邏輯,不得擅自改變對外行為、輸入輸出契約或副作用;任何無法可靠等價推論的改動一律不做,並以註解或回報標註「需人工確認」。新增 `input` 僅限依「參數來源優先序」經使用者同意後為之。
|
||||
- **不擴及無關檔案**:本 skill 只動 action 專案根目錄內的:主程式、主程式依賴鏈的 `.js`(搬移到 `src/`)、`package.json`、`action.yml`/`action.yaml`、`entrypoint.sh`、`Dockerfile`、`.dockerignore`,以及階段 E 由 doc-funcs 流程處理的目標;排除 `node_modules`/`.git`/`.docs`/`bin`/`obj`/第三方依賴。
|
||||
|
||||
---
|
||||
|
||||
## 參數來源優先序(開發中需要新參數時)
|
||||
|
||||
從零建立(A1a)、主程式 Node 化(階段 B)、產生 `entrypoint.sh`(階段 C)或產生 `Dockerfile`(階段 D)的過程中,若需要新的參數值,依下列順序處理,**前一項可取得就不往下**:
|
||||
|
||||
1. **runner 注入的執行期環境變數(`gitea.*`/`github.*` context 的同源資訊)**:Docker 容器 action 的 `action.yml` 內 expression 幾乎只有 `inputs`/`env` context 可用,但 runner 會把 `gitea.*`/`github.*` 的同源資訊以**執行期環境變數注入容器**——Node 主程式以 `process.env.GITHUB_*` 讀取(如 `GITHUB_REPOSITORY`、`GITHUB_SERVER_URL`、`GITHUB_REF_NAME`、`GITHUB_EVENT_PATH`;Gitea 亦提供 `GITEA_*` 同義變數),`entrypoint.sh` 內以 `$GITHUB_*` 讀取。為同時相容 GitHub Actions,程式內建議讀 `GITHUB_*`。
|
||||
2. **環境變數無法取得 → 詢問使用者新增 `inputs`**:以 `AskUserQuestion` 詢問使用者是否新增對應 `input`(名稱/description/`required`/`default`),經同意後於 `inputs` 宣告,容器內以 `INPUT_<大寫名稱>` 環境變數取用(Node 主程式讀 `process.env.INPUT_<NAME>`);未經同意**不得**擅自更動 `inputs`/`outputs` 契約。
|
||||
|
||||
**secrets/vars 一律視為不可用,不列入優先序**:`${{ secrets.* }}`/`${{ vars.* }}` context 在 Docker 容器 action 的 `action.yml`(`runs.args`/`runs.env`)內於 GitHub 為不可用(官方文件僅記載 `inputs` context 可用;runner 也不會把呼叫端的 secrets 自動注入容器);Gitea act_runner 未嚴格檢查 context 可用性、行為無保證。為求兩邊相容,本 skill 一律視為不可用——參數值本質上屬 secrets/vars 者,直接依第 2 項宣告為 `input`,回報時附上呼叫端 workflow 的傳入寫法:
|
||||
|
||||
```yaml
|
||||
- uses: <owner>/<action>@<ref>
|
||||
with:
|
||||
token: ${{ secrets.MY_TOKEN }} # secrets 由呼叫端 workflow 傳入
|
||||
registry: ${{ vars.MY_REGISTRY }} # vars 亦同
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 參數
|
||||
|
||||
格式:`[--action-dir <action 根目錄>] [--node-version <node tag>] [--main <主程式檔>] [--yes]`
|
||||
格式:`[--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`)。**省略時預設使用最新 node 版本**(`node:latest`,見階段 D)。
|
||||
- `--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 自動判斷。
|
||||
- `--yes`:盡量不中斷。即使帶此參數,「主程式非 Node 需改寫」與 doc-funcs 的「如何實作」仍會詢問。
|
||||
|
||||
---
|
||||
|
||||
@@ -46,7 +63,17 @@ argument-hint: "[--action-dir <action 根目錄>] [--node-version <node tag>] [-
|
||||
|
||||
- 帶 `--action-dir` → 採用(展開 `~`)。
|
||||
- 省略 → 用目前工作目錄。
|
||||
- 根目錄須存在 `action.yml` 或 `action.yaml`(action manifest)。**找不到** action manifest → 回報「此目錄不是 action 專案(缺 action.yml/action.yaml)」並詢問正確路徑,**不臆測**、不在非 action 專案上動工。
|
||||
- 根目錄須存在 `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 名稱與用途
|
||||
|
||||
@@ -71,7 +98,7 @@ argument-hint: "[--action-dir <action 根目錄>] [--node-version <node tag>] [-
|
||||
|
||||
---
|
||||
|
||||
## 階段 B:主程式 Node 化,並將所有 `.js` 收進 `src/`
|
||||
## 階段 B:主程式 Node 化,並將主程式依賴鏈的 `.js` 收進 `src/`
|
||||
|
||||
### B1. 主程式 Node 化
|
||||
|
||||
@@ -82,10 +109,11 @@ argument-hint: "[--action-dir <action 根目錄>] [--node-version <node tag>] [-
|
||||
- 任何無法可靠等價翻譯處,**不臆測**:以 `// 需人工確認:...` 標註並回報。
|
||||
- 改寫完成後,原非 Node 主程式於 B2 一併處理(移除或保留由使用者裁示;預設保留並在 README/回報標註已由 Node 取代)。
|
||||
|
||||
### B2. 所有 `.js` 集中到 `src/`
|
||||
### B2. 主程式依賴鏈的 `.js` 集中到 `src/`
|
||||
|
||||
- 在 action 根目錄建立 `src/`(若不存在)。
|
||||
- 將專案內所有 `.js`/`.mjs`/`.cjs`(排除 `node_modules`/`.git`/`.docs`/`bin`/`obj`/第三方依賴)**移入 `src/`**,優先 `git mv` 保留歷史。主程式入口統一為 `src/index.js`(或 `src/<main>.js`)。
|
||||
- 將**主程式入口及其 `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/...`)。
|
||||
@@ -100,10 +128,13 @@ argument-hint: "[--action-dir <action 根目錄>] [--node-version <node tag>] [-
|
||||
runs:
|
||||
using: docker
|
||||
image: Dockerfile
|
||||
entrypoint: entrypoint.sh
|
||||
```
|
||||
|
||||
若原本是 JS action(`using: node*`),改為上述 docker 設定;若已是 docker action,確認 `image` 指向 `Dockerfile`、`entrypoint` 指向 `entrypoint.sh`。
|
||||
- **不設 `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`。
|
||||
|
||||
---
|
||||
|
||||
@@ -111,9 +142,10 @@ runs:
|
||||
|
||||
在 action 根目錄產生(或覆寫)`entrypoint.sh`:**啟動 node 主程式前,先輸出 action 名稱、用途、更新時間**。
|
||||
|
||||
- **更新時間**為產生此檔當下的時間戳,使用台灣時區(Asia/Taipei)並固定為 `yyyy/MM/dd HH:mm:ss`(可用 `TZ='Asia/Taipei' date +'%Y/%m/%d %H:%M:%S'` 取得),**寫成檔內固定字串**(非執行期動態時間)。
|
||||
- **更新時間**語意為「本檔最後由本 skill 產生/更新的時間」,使用台灣時區(Asia/Taipei)並固定為 `yyyy/MM/dd HH:mm:ss`(可用 `TZ='Asia/Taipei' date +'%Y/%m/%d %H:%M:%S'` 取得),**寫成檔內固定字串**(非執行期動態時間)。本階段先寫入暫定時間戳,**階段 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 入口而定):
|
||||
|
||||
@@ -137,9 +169,9 @@ exec node /action/src/index.js "$@"
|
||||
|
||||
---
|
||||
|
||||
## 階段 D:產生 Dockerfile(使用最新 node 版本,六步流程依主程式實作量身產生)
|
||||
## 階段 D:產生 Dockerfile(使用最新 LTS node 版本,六步流程依主程式實作量身產生)
|
||||
|
||||
在 action 根目錄產生(或覆寫)`Dockerfile`,**base image 使用最新 node 版本**,採**多階段建置**以縮小最終映像檔。六步流程是**骨架**,但**每一步的實際內容必須依階段 B 的主程式(`src/`)實作決定**——不要套用與主程式無關的固定樣板,也不要硬塞主程式用不到的安裝或建置指令。
|
||||
在 action 根目錄產生(或覆寫)`Dockerfile`,**base image 使用最新 LTS node 版本(固定 major tag)**,採**多階段建置**以縮小最終映像檔。六步流程是**骨架**,但**每一步的實際內容必須依階段 B 的主程式(`src/`)實作決定**——不要套用與主程式無關的固定樣板,也不要硬塞主程式用不到的安裝或建置指令。
|
||||
|
||||
### D0. 先盤點主程式實作需求
|
||||
|
||||
@@ -150,57 +182,60 @@ exec node /action/src/index.js "$@"
|
||||
- **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`;不需 build 時加 `--omit=dev`,需 build 時先裝完整相依(含 dev)供第 4 步使用。**只在主程式真的會用到時**才 `apt-get install` OS 套件,並於同一 `RUN` 清掉 apt 快取。先 `COPY` 相依描述(`package*.json`)再安裝,以利 layer 快取。
|
||||
3. **複製檔案**:`COPY` 主程式實際需要的檔案(`src/`、`entrypoint.sh`,及主程式會讀取的資源);不需要的檔案不必帶入。
|
||||
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 相依與快取帶進最終映像。
|
||||
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 版本:預設 build 基底 `node:latest`、runtime 基底 `node:slim`(皆為最新版,slim 用於縮小);帶 `--node-version <tag>`(如 `22`、`lts`)時改用 `node:<tag>` 與 `node:<tag>-slim`。若需確認當前最新穩定版號,可查詢 Docker Hub(`https://hub.docker.com/_/node`)後於 `FROM` 註記實際版本,但**預設行為是使用最新版**。
|
||||
base image 版本:**預設使用產生當下的最新 LTS major 固定 tag**(如 build 基底 `node:22`、runtime 基底 `node:22-slim`)——docker action 每次執行都由 runner 現場 build,用 `latest` 會隨 base 無預警跳版而行為漂移、跨 runner 不一致、無法重現除錯;可查詢 Docker Hub(`https://hub.docker.com/_/node`)確認當前 LTS 版號。帶 `--node-version <tag>` 時改用 `node:<tag>` 與 `node:<tag>-slim`;`latest` 僅在**使用者明確要求**時使用(此時 runtime 用 `node:slim`,因為沒有 `node:latest-slim` 這個 tag)。
|
||||
|
||||
下列為**最簡基準骨架**(純 JS、無 build、無 OS 相依的情況);實際內容須依 D0 盤點調整,第 4 步建置、第 2/5 步 OS 套件等視主程式需要增刪:
|
||||
|
||||
```Dockerfile
|
||||
# syntax=docker/dockerfile:1
|
||||
|
||||
# 1. 參數處理:node 版本以 ARG 注入(預設最新版;--node-version 可覆寫)
|
||||
ARG NODE_VERSION=latest
|
||||
ARG NODE_RUNTIME=slim
|
||||
# 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/ 相依
|
||||
# (需 build 時改裝完整相依;需 OS 套件時於此 apt-get install 並清快取)
|
||||
# (依 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 || npm install --omit=dev); \
|
||||
cd /action/src && npm ci --omit=dev; \
|
||||
fi
|
||||
|
||||
# 3. 複製檔案:複製主程式實際需要的檔案
|
||||
COPY . /action
|
||||
# 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 基底、只帶必要產物
|
||||
# 5. 縮小映像檔:多階段建置,runtime 改用 slim 基底,逐項明列只帶執行真正需要的產物
|
||||
# (有 build 產物時改帶 dist/ 與 production node_modules;runtime 需要的 OS 執行檔於此安裝)
|
||||
FROM node:${NODE_RUNTIME} AS runtime
|
||||
WORKDIR /action
|
||||
COPY --from=build /action /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 套件;用不到的步驟內容不要硬塞。
|
||||
- **版號對齊**:runtime 的 slim 基底版號需與 build 基底一致。預設 `node:latest` ↔ `node:slim`;帶 `--node-version 22` 時設 `NODE_VERSION=22`、`NODE_RUNTIME=22-slim`。注意**沒有 `node:latest-slim` 這個 tag**,最新版 slim 一律用 `node:slim`,故以獨立的 `NODE_RUNTIME` 參數帶入、不要用 `${NODE_VERSION}-slim` 組裝。
|
||||
- **自我檢查**:`entrypoint.sh` 的 `node <主程式>` 路徑(如 `/action/src/index.js`)需與 `Dockerfile` 的 `WORKDIR`/`COPY` 落點一致,避免容器啟動時找不到主程式。
|
||||
- **若階段 B 裁示「維持非 Node」**:base image 改用對應語言官方映像(如 `python:3-slim`),第 2 步改安裝該生態相依(如 `pip install -r requirements.txt`),其餘六步結構不變;`ENTRYPOINT` 仍指向 `entrypoint.sh`(其內 `exec` 原直譯器,見階段 C)。
|
||||
- **版號對齊**:runtime 基底版號需與 build 基底一致。預設 LTS 固定 tag(如 `NODE_VERSION=22`、`NODE_RUNTIME=22-slim`);帶 `--node-version` 時同理對應。tag 已是 `-alpine`/`-slim` 變體(如 `22-alpine`)時,build 與 runtime **直接沿用同一 tag**、不再另組 `-slim`(沒有 `node:22-alpine-slim` 這種 tag)。使用者明確要求 `latest` 時 runtime 用 `node:slim`(**沒有 `node:latest-slim`**)。故一律以獨立的 `NODE_RUNTIME` 參數帶入、不要用 `${NODE_VERSION}-slim` 組裝。
|
||||
- **自我檢查**:`entrypoint.sh` 的 `node <主程式>` 路徑(如 `/action/src/index.js`)需與 `Dockerfile` 的 `WORKDIR`/`COPY` 落點一致,避免容器啟動時找不到主程式;`action.yml` 的 `runs.entrypoint` 若存在,必須是**絕對路徑**且與 `Dockerfile` 落點一致(預設不設,讓 Dockerfile 的 `ENTRYPOINT` 生效)。
|
||||
- 此檔的用途/更新日期註解與逐行註解,同樣於階段 E 由 doc-funcs 指令檔流程統一補齊。
|
||||
|
||||
---
|
||||
@@ -209,10 +244,12 @@ ENTRYPOINT ["/action/entrypoint.sh"]
|
||||
|
||||
容器化與 Node 化完成後,對**整個 action 專案**完整執行 `/jsc:doc-funcs` 流程,替程式碼與指令檔補文件並重建 README:
|
||||
|
||||
- **前置檢查**:先確認 doc-funcs skill 可用(`/jsc:doc-funcs`);不可用則回報並**略過本階段**,於總結標註「未文件化」。
|
||||
- 以階段 A1 的 action 根目錄為目標,執行 `doc-funcs` skill 的完整流程(判斷語言 → 掃描 function 與指令檔 → 建立 `.docs/` 草稿 → 草稿品質檢查 → 詢問使用者如何實作 → 依選擇寫回 → 保守優化 → 重建 README → 錨點檢查 → 清理草稿 → 建置/語法驗證)。
|
||||
- doc-funcs 會涵蓋本次新增/變更的指令檔:`entrypoint.sh`(補齊「用途+更新日期同一註解區塊」與逐行註解)、`Dockerfile`(逐行註解);以及 `src/` 內 Node 主程式與各 function 的文件註解。
|
||||
- doc-funcs 的「如何實作」詢問(全部一起/逐個/其他)由使用者於該流程內裁示,本 skill 不代為決定。
|
||||
- 完成後依 doc-funcs 規範重建根目錄 `README.md`(含台灣時區更新時間、專案列表、功能列表、使用範例)。
|
||||
- **統一時間戳**:doc-funcs 全部完成後,以完成當下的 Asia/Taipei 時間(`yyyy/MM/dd HH:mm:ss`)回頭同步 `entrypoint.sh` 橫幅輸出與註解區塊、`Dockerfile` 註解區塊與 README 的更新時間,**確保各處時間戳一致**。
|
||||
|
||||
> 銜接方式:在本 skill 環境中以 `/jsc:doc-funcs`(或 Skill 工具)啟動 doc-funcs 流程;若該流程需參數,沿用本 skill 的 action 根目錄為目標專案。
|
||||
|
||||
@@ -222,8 +259,8 @@ ENTRYPOINT ["/action/entrypoint.sh"]
|
||||
|
||||
各階段執行後輸出:
|
||||
|
||||
- **階段 A**:action 根目錄、action 名稱/用途、原主程式檔與語言、是否為 Node。
|
||||
- **階段 B**:是否改寫主程式(及改寫摘要與「需人工確認」清單)、搬入 `src/` 的 `.js` 清單、已更新的引用(`package.json`/`action.yml`/路徑)。
|
||||
- **階段 A**:action 根目錄、action 名稱/用途、原主程式檔與語言、是否為 Node;若走 A1a 從零建立,列出問答收集結果(名稱/輸入輸出/目標)。
|
||||
- **階段 B**:是否改寫主程式(及改寫摘要與「需人工確認」清單)、搬入 `src/` 的 `.js` 清單、已更新的引用(`package.json`/`action.yml`/路徑);依「參數來源優先序」新增的 `inputs` 清單與呼叫端傳入寫法(若有)。
|
||||
- **階段 C/D**:`entrypoint.sh` 的輸出內容(名稱/用途/更新時間)與啟動的 node 主程式、`Dockerfile` 採用的 node 版本與 `ENTRYPOINT`。
|
||||
- **階段 E**:doc-funcs 流程的處理結果(文件化的 function 與指令檔、重建的 README)。
|
||||
- 列出本次新增/變更的檔案與其相對路徑,並提醒使用者於提交前確認 `entrypoint.sh` 有可執行權限、容器能正確啟動。
|
||||
@@ -232,10 +269,10 @@ ENTRYPOINT ["/action/entrypoint.sh"]
|
||||
|
||||
## 呼叫方式
|
||||
|
||||
格式:`[--action-dir <action 根目錄>] [--node-version <node tag>] [--main <主程式檔>] [--yes]` — 全部可省略(根目錄預設目前工作目錄;node 版本預設最新;主程式自動判斷)。
|
||||
格式:`[--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 | `$code-action-docker`,或 `$code-action-docker --action-dir ~/work/my-action`,或用 `/skills` 選單 |
|
||||
| OpenCode | 描述需求(如「把這個 action 主程式改成 node、所有 js 收進 src/,產生會先輸出 action 名稱/用途/更新時間再啟動 node 的 entrypoint.sh、用最新 node 版本的 Dockerfile,最後跑 doc-funcs 補文件並重建 README」)自動觸發 |
|
||||
| OpenCode | 描述需求(如「把這個 action 主程式改成 node、主程式相關 js 收進 src/,產生會先輸出 action 名稱/用途/更新時間再啟動 node 的 entrypoint.sh、用最新 LTS node 版本的 Dockerfile,最後跑 doc-funcs 補文件並重建 README」)自動觸發 |
|
||||
|
||||
Reference in New Issue
Block a user