feat(action skills): composite/docker action 標準化流程強化(參數優先序、從零建立、Dockerfile 修正) #6

Merged
admin merged 27 commits from develop into master 2026-07-17 03:36:44 +00:00
Showing only changes of commit 099f17e067 - Show all commits
+130 -102
View File
@@ -1,144 +1,168 @@
---
name: code-action-docker
description: 以互動問答從零打造 GiteaGitHub「Docker 容器 action」(1) 詢問 action 名稱(用於 action.yml 的 name);(2) 詢問輸入與輸出參數及其 description(盡量繁體中文、無亂碼);(3) 詢問執行此流程的目標,整理濃縮成一句話(用於 action.yml 的 description,盡量繁體中文、無亂碼);(4) 依標準實作目標——盡量以 Node.js 開發、程式檔一律放 `src/`、盡量詳細輸出訊息且格式統一為 `[yyyy/MM/dd HH:mm:ss][階段][等級]: 訊息`(無階段則移除該 `[]`,等級為 INF/WRN/ERR/TRC/DBG),並產生 action.ymlentrypoint.sh最新 node 版本的 Dockerfile(5) 檢查是否有 doc-funcs 技能,有則完整執行 `/jsc:doc-funcs`,否則結束。當使用者說建立/產生一個 docker action、從零做一個容器 action、幫我問完需求後生出 action、把需求做成 node docker action,或提到 code-action-docker 時觸發。不適用於:composite action(用 code-action-composite)、只整理既有 Dockerfile(用 code-image)、非 action 專案
argument-hint: "[--action-dir <action 根目錄>] [--node-version <node tag>]"
description: GiteaGitHub「Docker 容器 action」專案標準化為 Node 主程式+容器化,並串接文件化流程:(1) 檢查 action 主程式是否為 Node,否則保守改寫為 Node,且所有 `.js` 檔一律集中到 `src/` 資料夾;(2) 產生 `entrypoint.sh`,啟動前先輸出 action 名稱/用途/更新時間,再執行 node 主程式;(3) 產生使用最新 node 版本的 `Dockerfile`(4) 最後完整執行 `/jsc:doc-funcs` 處理流程(function 文件、指令檔逐行註解、重建 README)。當使用者說把 action 改成 dockernode、容器 action、action 主程式 node 化、把 js 收進 src、產 entrypoint.shDockerfile 給 action,或提到 code-action-docker 時觸發。不適用於:非 action 專案、純前端打包、或不需容器化的一般 repo
argument-hint: "[--action-dir <action 根目錄>] [--node-version <node tag>] [--main <主程式檔>] [--yes]"
---
# code-action-docker — 問答式打造 Docker 容器 actionNode 主程式)+文件化
# code-action-docker — action 容器化Node 主程式)+文件化
五階段 skill:先以問答收齊需求——**action 名稱**(階段 1)、**輸入與輸出參數**(階段 2)、**流程目標並濃縮成一句話**(階段 3)——再依標準**實作目標**(階段 4:Node.js、程式檔一律放 `src/`、統一訊息格式,並產生 `action.yml``entrypoint.sh`最新 node 版本的 `Dockerfile`),最後**檢查是否有 doc-funcs 技能**(階段 5):有則完整執行 `/jsc:doc-funcs`,否則結束
五階段 skill:先做**前置設定與偵測**(找出 action 專案、讀取名稱/用途、判斷主程式語言),再把**主程式 Node 化並將所有 `.js` 收進 `src/`**,接著產生**啟動前先輸出 action 名稱/用途/更新時間的 `entrypoint.sh`**,然後產生**使用最新 node 版本的 `Dockerfile`**(並對齊 `action.yml` 的 docker 設定),最後**完整執行 `/jsc:doc-funcs` 處理流程**替整個專案補文件並重建 README
| 階段 | 動作 |
| --- | --- |
| 1. 詢問 action 名稱 | 向使用者詢問 action 名稱 → 寫入 `action.yml``name` |
| 2. 詢問輸入與輸出參數 | 逐一收齊 `inputs``outputs`(名稱、description、required、default)→ description 盡量繁體中文、無亂碼 |
| 3. 詢問流程目標 | 詢問此 action 要達成什麼 → 整理並**濃縮成一句話**,經使用者確認後寫入 `action.yml``description`(盡量繁體中文、無亂碼) |
| 4. 實作目標 | 盡量以 **Node.js** 開發、程式檔**一律放 `src/`**;訊息詳細且格式統一為 `[yyyy/MM/dd HH:mm:ss][階段][等級]: 訊息`;產生 `action.yml``entrypoint.sh`/最新 node 版本的 `Dockerfile` |
| 5. 檢查 doc-funcs | 有 doc-funcs 技能 → 完整執行 `/jsc:doc-funcs`;沒有 → 回報後結束 |
| A. 前置設定與偵測 | 決定 action 根目錄 → 讀 `action.yml``action.yaml``name``description` → 判斷目前主程式與語言 |
| 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` |
| E. 串接 doc-funcs | 對整個 action 專案完整執行 `/jsc:doc-funcs` 流程(function 文件、指令檔逐行註解、重建 README) |
---
## 輸出規範(務必遵守)
- **語言**:所有面向使用者的輸出(問題、計畫、進度、總結)一律使用**繁體中文(台灣用語)**;僅識別字、檔名、git/docker 指令、API 路徑、程式碼等技術標識保留原文,**不可**使用簡體字。
- **編碼無亂碼**:凡輸出含繁體中文、全形標點、emoji,一律 **UTF-8(不含 BOM**,不得出現問號方框或錯碼。產生的 `action.yml``src/*.js``entrypoint.sh``Dockerfile``README.md` 同樣需 UTF-8(不含 BOM`action.yml` 內的中文 `name``description`/參數說明必須能被 YAML 正確解析與顯示
- **問答原則**階段 1~3 是**必要輸入**,缺一不可;使用者已在呼叫時提供的答案不再重複詢問,未提供的必須以 `AskUserQuestion`(或明確反問)取得,**不得臆測代答**。階段 4 起除必要決策外直接執行到完成
- **不破壞既有工作**若 action 根目錄已存在 `action.yml``src/``entrypoint.sh``Dockerfile`,覆寫前先回報並確認;工作區有未提交變更提醒使用者先 commit/備份;**絕不** `reset --hard``checkout -f``clean`,也不刪除使用者既有原始碼。
- **不擴及無關檔案**:本 skill 只產生/修改 action 根目錄內的 `action.yml``src/``entrypoint.sh``Dockerfile``package.json`,以及階段 5 由 doc-funcs 流程處理的目標;排除 `node_modules``.git``.docs``bin``obj`/第三方依賴
- **語言**:所有面向使用者的輸出(計畫、進度、總結、反問)一律使用**繁體中文(台灣用語)**;僅識別字、檔名、git/docker 指令、API 路徑、程式碼等技術標識保留原文,**不可**使用簡體字。
- **編碼無亂碼**:凡輸出含繁體中文、全形標點、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`/第三方依賴。
---
## 參數
格式:`[--action-dir <action 根目錄>] [--node-version <node tag>]`
格式:`[--action-dir <action 根目錄>] [--node-version <node tag>] [--main <主程式檔>] [--yes]`
- `--action-dir <action 根目錄>`:action 專案根目錄。**省略時預設目前工作目錄**。
- `--node-version <node tag>``Dockerfile` 的 node base image tag(如 `22``22-alpine``lts`)。**省略時預設使用最新 node 版本**(`node:latest`,見階段 4)。
階段 1~3 的答案(名稱、輸入輸出參數、目標)不設 CLI 參數;使用者若已在呼叫訊息中口述,直接採用、不再重問。
- `--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)。
- `--main <主程式檔>`:指定主程式入口檔(相對 action 根目錄)。省略時依 A3 自動判斷。
- `--yes`:盡量不中斷。即使帶此參數,「主程式非 Node 需改寫」與 doc-funcs 的「如何實作」仍會詢問。
---
## 階段 1:詢問 action 名稱
## 階段 A:前置設定與偵測
向使用者詢問 **action 名稱**,用於 `action.yml``name`
### A1. 決定 action 根目錄
- 使用者已在呼叫時提供 → 直接採用並回報
- 未提供 → 以 `AskUserQuestion`(自由輸入為主,可依目錄名/repo 名給 2~3 個建議選項)詢問,**不得自行編造**
- 名稱不得為空;可為繁體中文或英文,原樣寫入 `name`,不擅自翻譯或改寫
- `--action-dir` → 採用(展開 `~`
- 省略 → 用目前工作目錄
- 根目錄須存在 `action.yml``action.yaml`action manifest)。**找不到** action manifest → 回報「此目錄不是 action 專案(缺 action.ymlaction.yaml)」並詢問正確路徑,**不臆測**、不在非 action 專案上動工
## 階段 2:詢問輸入與輸出參數
### A2. 讀取 action 名稱與用途
向使用者收齊 action 的**輸入(`inputs`)與輸出(`outputs`)參數**,逐項確認
action manifest 讀取
- **每個輸入**:參數名稱(建議 kebab-case)、`description`(**盡量繁體中文、無亂碼**)、是否必填(`required`)、預設值(`default`,選填)。
- **每個輸出**:參數名稱、`description`**盡量繁體中文、無亂碼**
- 使用者明確表示「無輸入」或「無輸出」→ 對應區塊留空(省略該區塊),不硬造參數
- description 缺漏時**反問補齊**,不編造;使用者堅持留空則標示「(未提供)」。
- 收齊後輸出整理表(名稱/必填/預設值/說明)讓使用者確認,再進入階段 3。
- `name`action 名稱(供 `entrypoint.sh` 輸出與 README 使用)。
- `description`action 用途
- `runs`:目前的執行設定(`using``main``image``entrypoint` 等)
實作對應(供階段 4 使用):輸入在容器內以 `INPUT_<大寫參數名>` 環境變數取得(`-``_`);輸出以附加 `name=value``$GITHUB_OUTPUT` 檔案寫出
`name``description` 缺漏,回報並請使用者補;無法取得時於後續輸出以「(未提供)」保守標示,**不編造**
## 階段 3:詢問執行此流程的目標
### A3. 判斷目前主程式與語言
向使用者詢問**此 action 要達成什麼目標**(要處理什麼、產出什麼、成功/失敗準則):
依序判斷主程式入口(取第一個成立者):
- 追問到「可實作」為止:不清楚的環節(資料來源、外部指令、失敗時的行為)必須問清,**不得臆測**
- 將目標**整理並濃縮成一句話**(盡量繁體中文、無亂碼),向使用者確認後寫入 `action.yml``description`
- 完整目標描述(含細節與邊界)保留於回報與階段 4 的實作依據,不因濃縮而遺失
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` 等)。
## 階段 4:實作目標(Node.js、src/、統一訊息格式)
判定**主程式是否為 Node**:入口為 `.js``.mjs``.cjs` 且由 `node` 執行即視為 Node;入口為 shellpython/其他則視為非 Node。輸出偵測結果(action 名稱、用途、主程式檔、判定語言、是否為 Node),再進入階段 B。
依階段 1~3 收齊的需求實作 action,遵守以下標準:
---
### 4.1 盡量以 Node.js 開發,程式檔一律放 `src/`
## 階段 B:主程式 Node 化,並將所有 `.js` 收進 `src/`
- 主程式與所有模組**盡量以 Node.js 撰寫**;只有目標必須依賴外部工具時,才以 `child_process``execFileSync``spawnSync`)在 Node 內呼叫,不另寫 shellpython 主程式。
- 所有 `.js``.mjs``.cjs`**一律放在 `src/` 資料夾內**,主程式入口統一為 `src/index.js`;需要相依套件時於 `src/` 建立 `package.json``main` 指向入口檔),不擅自新增與目標無關的相依。
- 輸入用 `process.env.INPUT_*` 讀取(必填缺漏 → 輸出 `ERR` 訊息並以非零 exit code 結束);輸出寫入 `process.env.GITHUB_OUTPUT`
### B1. 主程式 Node 化
### 4.2 盡量詳細輸出訊息,格式統一
- **已是 Node** → 確認入口檔,不改寫邏輯,直接進 B2。
- **非 Nodeshellpython/其他)** → 這是**破壞性高風險決策**:先以 `AskUserQuestion` 向使用者確認是否改寫為 Node,選項至少含「改寫為 Node」「維持原樣只做容器化(略過改寫)」「其他」。經確認後才改寫:
- 逐段把原主程式邏輯**保守翻譯**為 Node(建議 `index.js`);保留對外行為、輸入(環境變數/`INPUT_*`args)與輸出(stdoutexit code/檔案副作用)契約。
- 外部指令呼叫以 `child_process``execFileSync``spawnSync`)對應;檔案操作以 `fs`;環境變數以 `process.env`
- 任何無法可靠等價翻譯處,**不臆測**:以 `// 需人工確認:...` 標註並回報。
- 改寫完成後,原非 Node 主程式於 B2 一併處理(移除或保留由使用者裁示;預設保留並在 README/回報標註已由 Node 取代)。
- 執行過程**盡量詳細輸出**:開始/結束、讀到的輸入、每個關鍵步驟、外部指令與結果、寫出的輸出、警告與錯誤。
- 每一則訊息格式固定為:
### B2. 所有 `.js` 集中到 `src/`
```
[yyyy/MM/dd HH:mm:ss][階段][等級]: 訊息
```
- 在 action 根目錄建立 `src/`(若不存在)。
- 將專案內所有 `.js``.mjs``.cjs`(排除 `node_modules``.git``.docs``bin``obj`/第三方依賴)**移入 `src/`**,優先 `git mv` 保留歷史。主程式入口統一為 `src/index.js`(或 `src/<main>.js`)。
- **移動後必須更新所有引用**,確保不破壞:
- 模組間的 `require``import` 相對路徑。
- `package.json``main``bin``scripts``exports`(指向 `src/...`)。
- `action.yml``Dockerfile``entrypoint.sh` 內對主程式路徑的引用。
-`src/` 下無 `package.json` 而專案需要相依,於 `src/` 建立或移入 `package.json``main` 指向入口檔;不擅自新增與功能無關的相依。
- **時間**:台灣時區(Asia/Taipei),固定 `yyyy/MM/dd HH:mm:ss`。
- **階段**:該訊息所屬的流程階段名稱(如 `讀取輸入`、`執行`、`寫出結果`);**沒有階段時整個 `[階段]` 區塊移除**,即 `[yyyy/MM/dd HH:mm:ss][等級]: 訊息`。
- **等級**:必為 `INF``WRN``ERR``TRC``DBG` 其中之一(一般資訊 INF、警告 WRN、錯誤 ERR、細部追蹤 TRC、除錯 DBG)。
- **一行一則訊息**:每則訊息獨立一行輸出,不得多則併成一坨。
- 在 `src/logger.js` 實作共用 logger(產生時間戳、組合前綴、`INF`/`WRN`/`ERR`/`TRC`/`DBG` 各一個方法、可帶階段名稱),主程式一律經由它輸出;`ERR` 走 `console.error`,其餘走 `console.log`。
- 錯誤處理:可預期錯誤輸出 `ERR` 訊息並 `process.exit(1)`;未捕捉例外亦須被攔截(`process.on('uncaughtException'/'unhandledRejection')`)以 `ERR` 格式輸出後非零結束。
### B3. action.yml 對齊 docker
### 4.3 產生 action.yml
以階段 12 的答案組出 `action.yml`(中文內容 UTF-8、無亂碼):
將 manifest 的 `runs` 對齊為 docker 容器 action(保留既有 `inputs``outputs``name``description`):
```yaml
name: <階段 1 的 action 名稱>
description: <階段 3 濃縮的一句話>
inputs:
<參數名>:
description: <階段 2 的說明(盡量繁體中文)>
required: true|false
default: <預設值(若有)>
outputs:
<參數名>:
description: <階段 2 的說明(盡量繁體中文)>
runs:
using: docker
image: Dockerfile
entrypoint: entrypoint.sh
```
無輸入/輸出時省略對應區塊
若原本是 JS action`using: node*`),改為上述 docker 設定;若已是 docker action,確認 `image` 指向 `Dockerfile``entrypoint` 指向 `entrypoint.sh`
### 4.4 產生 entrypoint.sh
---
在 action 根目錄產生 `entrypoint.sh`:啟動 node 主程式前,先輸出 action **名稱/用途/更新時間**,且每則輸出同樣遵守 4.2 訊息格式(階段用 `啟動`):
## 階段 C產生 entrypoint.sh(先輸出名稱/用途/更新時間,再啟動 node 主程式)
在 action 根目錄產生(或覆寫)`entrypoint.sh`:**啟動 node 主程式前,先輸出 action 名稱、用途、更新時間**。
- **更新時間**為產生此檔當下的時間戳,使用台灣時區(Asia/Taipei)並固定為 `yyyy/MM/dd HH:mm:ss`(可用 `TZ='Asia/Taipei' date +'%Y/%m/%d %H:%M:%S'` 取得),**寫成檔內固定字串**(非執行期動態時間)。
- 名稱/用途取自階段 A2 的 `action.yml`
- 最後以 `exec node <主程式>`(如 `exec node /action/src/index.js "$@"`)啟動,讓 node 取代 shell 行程,正確傳遞訊號與 exit code;路徑須與階段 D 的 `Dockerfile` 落點一致。
範例(實際路徑依階段 B 入口而定):
```sh
#!/bin/sh
set -e
# action 啟動訊息:名稱/用途/更新時間(此檔由 code-action-docker 產生)
echo "[<產生當下 Asia/Taipei 時間>][啟動][INF]: Action<action 名稱>"
echo "[<產生當下 Asia/Taipei 時間>][啟動][INF]: 用途:<action.yml 的 description>"
echo "[<產生當下 Asia/Taipei 時間>][啟動][INF]: 更新時間:<產生當下 Asia/Taipei 時間>"
# action 啟動橫幅:輸出名稱/用途/更新時間(此檔由 code-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 "$@"
```
- 「更新時間」為產生此檔當下的時間戳(`TZ='Asia/Taipei' date +'%Y/%m/%d %H:%M:%S'`),**寫成檔內固定字串**;名稱/用途取自階段 1/3。
- 賦予可執行權限:`chmod +x entrypoint.sh`(並於 git 標記為可執行)。
- 此檔開頭的「用途/更新時間」與每行註解,最終會在階段 E 由 `/jsc:doc-funcs` 的指令檔流程統一補齊/覆寫為標準格式(用途與更新日期同一註解區塊、逐行註解);本階段先確保**執行期輸出**正確即可。
### 4.5 產生 Dockerfile(使用最新 node 版本)
---
在 action 根目錄產生 `Dockerfile`**base image 使用最新 node 版本**,採**多階段建置**縮小最終映像,內容依 `src/` 實作量身決定(有相依才裝、需要 OS 工具才 `apt-get install`,用不到的不硬塞):
## 階段 D產生 Dockerfile(使用最新 node 版本,六步流程依主程式實作量身產生)
在 action 根目錄產生(或覆寫)`Dockerfile`**base image 使用最新 node 版本**,採**多階段建置**以縮小最終映像檔。六步流程是**骨架**,但**每一步的實際內容必須依階段 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。
- **是否需要 buildtranspile**:有無 `scripts.build`、是否為 TypeScript/打包(產物落在 `dist/``build/` 等)。決定第 4 步是否要跑建置、第 5 步 runtime 該帶入哪個產物目錄。
- **OS 層相依**:主程式是否以 `child_process` 呼叫外部執行檔(如 `git``bash``openssl``python3``ffmpeg``imagemagick`),或使用需編譯的原生模組(node-gypnative addon)。決定第 2 步是否要 `apt-get install` 對應套件,以及第 5 步 runtime 基底是否需保留這些執行檔。
- **執行期需求**:主程式讀取的環境變數、需存取的檔案路徑、是否寫入暫存目錄。決定 `WORKDIR`、需 `COPY` 的檔案範圍與必要的 `ENV`
- **入口檔**:階段 B 決定的主程式入口(如 `src/index.js`),決定第 6 步與 `entrypoint.sh``node` 路徑。
### 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`,及主程式會讀取的資源);不需要的檔案不必帶入。
4. **執行程序**:賦予 `entrypoint.sh` 執行權限;**僅當 D0 判定需要 buildtranspile 時**才執行(如 `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 相依與快取帶進最終映像。
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` 註記實際版本,但**預設行為是使用最新版**。
下列為**最簡基準骨架**(純 JS、無 build、無 OS 相依的情況);實際內容須依 D0 盤點調整,第 4 步建置、第 2/5 步 OS 套件等視主程式需要增刪:
```Dockerfile
# syntax=docker/dockerfile:1
@@ -147,47 +171,50 @@ exec node /action/src/index.js "$@"
ARG NODE_VERSION=latest
ARG NODE_RUNTIME=slim
# ---- build 階段:安裝相依 ----
# ---- build 階段:安裝相依、準備產物 ----
FROM node:${NODE_VERSION} AS build
WORKDIR /action
# 2. 安裝套件:先帶相依描述以利 layer 快取(有 lockfile 用 npm ci
# 2. 安裝套件:先帶相依描述以利 layer 快取,再裝 src/ 相依
# (需 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); \
fi
# 3. 複製檔案:帶入主程式與入口
COPY src/ /action/src/
COPY entrypoint.sh /action/entrypoint.sh
# 3. 複製檔案:複製主程式實際需要的檔案
COPY . /action
# 4. 執行程序:賦予 entrypoint 執行權限
# 4. 執行程序:賦予 entrypoint 執行權限(D0 判定需要 build 時於此 npm run build
RUN chmod +x /action/entrypoint.sh
# 5. 縮小映像檔:runtime 改用 slim 基底只帶必要產物
# 5. 縮小映像檔:多階段建置,runtime 改用 slim 基底只帶必要產物
# (有 build 產物時改帶 dist/ 與 production node_modulesruntime 需要的 OS 執行檔於此安裝)
FROM node:${NODE_RUNTIME} AS runtime
WORKDIR /action
COPY --from=build /action /action
# 6. 設定入口:以 entrypoint.sh 啟動 node 主程式
# 6. 設定入口:以 entrypoint.sh 啟動(其內 node 指向 D0 的入口檔)
ENTRYPOINT ["/action/entrypoint.sh"]
```
- **版號對齊**:預設 build 基底 `node:latest`、runtime 基底 `node:slim`**沒有 `node:latest-slim` 這個 tag**,故以獨立 `NODE_RUNTIME` 參數帶入);帶 `--node-version 22` 時設 `NODE_VERSION=22`、`NODE_RUNTIME=22-slim`
- 主程式以 `child_process` 呼叫外部執行檔(如 `git`、`openssl`)時,於 runtime 階段補 `apt-get install` 對應套件並清快取
- **自我檢查**`entrypoint.sh` 的 `node /action/src/index.js` 路徑須與 `Dockerfile` 的 `WORKDIR``COPY` 落點一致。
- **依主程式實作**:上面只是基準骨架。若主程式是 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` 落點一致,避免容器啟動時找不到主程式
- 此檔的用途/更新日期註解與逐行註解,同樣於階段 E 由 doc-funcs 指令檔流程統一補齊。
### 4.6 驗證
---
- `node --check src/*.js` 驗證語法;有 `package.json` 時執行 `npm install`(或 `npm ci`)確認相依可解析。
- 環境有 docker 時執行 `docker build .` 驗證映像可建置;無法執行時明確說明原因並標註風險。
## 階段 E:完整執行 /jsc:doc-funcs 處理流程
## 階段 5:檢查是否有 doc-funcs 技能
容器化與 Node 化完成後,對**整個 action 專案**完整執行 `/jsc:doc-funcs` 流程,替程式碼與指令檔補文件並重建 README:
實作完成後,檢查目前環境是否有 **doc-funcs** 技能(可用 skill 清單中是否存在 `doc-funcs`,含 `/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`(含台灣時區更新時間、專案列表、功能列表、使用範例)。
- **有** → 以階段 4 的 action 根目錄為目標,**完整執行 `/jsc:doc-funcs` 流程**(判斷語言 → 掃描 function 與指令檔 → 建立 `.docs/` 草稿 → 詢問使用者如何實作 → 寫回 → 保守優化 → 重建 README → 清理草稿 → 驗證)。doc-funcs 會涵蓋本次產出:`src/` 內各 function 的 JSDoc、`entrypoint.sh``Dockerfile` 逐行註解、重建 README;其「如何實作」詢問由使用者於該流程內裁示。既有訊息一律維持本 skill 4.2 的 `[yyyy/MM/dd HH:mm:ss][階段][等級]: 訊息` 格式,不得被改寫成其他欄位順序
- **沒有** → 回報「未偵測到 doc-funcs 技能,略過文件化」後**結束**,不自行模擬 doc-funcs 流程。
> 銜接方式:在本 skill 環境中以 `/jsc:doc-funcs`(或 Skill 工具)啟動 doc-funcs 流程;若該流程需參數,沿用本 skill 的 action 根目錄為目標專案
---
@@ -195,19 +222,20 @@ ENTRYPOINT ["/action/entrypoint.sh"]
各階段執行後輸出:
- **階段 13**action 名稱、輸入/輸出參數整理表、濃縮後的一句話 description
- **階段 4**產出檔案清單(`action.yml`、`src/index.js`、`src/logger.js`、`src/package.json`(若有)、`entrypoint.sh`、`Dockerfile`)與各自相對路徑、採用的 node 版本、驗證結果(語法檢查/npmdocker build)。
- **階段 5**:是否偵測到 doc-funcs;有則附 doc-funcs 流程的處理結果(文件化的 function 與指令檔、重建的 README
- 提醒使用者於提交前確認 `entrypoint.sh` 有可執行權限、容器能正確啟動
- **階段 A**action 根目錄、action 名稱/用途、原主程式檔與語言、是否為 Node
- **階段 B**是否改寫主程式(及改寫摘要與「需人工確認」清單)、搬入 `src/``.js` 清單、已更新的引用(`package.json``action.yml`/路徑)。
- **階段 CD**`entrypoint.sh` 的輸出內容(名稱/用途/更新時間)與啟動的 node 主程式、`Dockerfile` 採用的 node 版本與 `ENTRYPOINT`
- **階段 E**doc-funcs 流程的處理結果(文件化的 function 與指令檔、重建的 README
- 列出本次新增/變更的檔案與其相對路徑,並提醒使用者於提交前確認 `entrypoint.sh` 有可執行權限、容器能正確啟動。
---
## 呼叫方式
格式:`[--action-dir <action 根目錄>] [--node-version <node tag>]` — 全部可省略(根目錄預設目前工作目錄;node 版本預設最新)。
格式:`[--action-dir <action 根目錄>] [--node-version <node tag>] [--main <主程式檔>] [--yes]` — 全部可省略(根目錄預設目前工作目錄;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 | 描述需求(如「幫我從零建一個 docker action:先問我名稱、輸入輸出參數與目標,用 node 實作放在 src/,訊息格式統一,最後跑 doc-funcs 補文件」)自動觸發 |
| OpenCode | 描述需求(如「把這個 action 主程式改成 node、所有 js 收進 src/,產生會先輸出 action 名稱/用途/更新時間再啟動 node 的 entrypoint.sh、用最新 node 版本的 Dockerfile,最後跑 doc-funcs 補文件並重建 README」)自動觸發 |