@elvis1513/auto-coding-skill 0.1.1 → 0.1.2

package/README.md

@@ -23,13 +23,10 @@ npm install -g git+https://github.com/elvis1513/auto-coding-skill.git
 
 ```bash
 autocoding init --ai codex
-# or
-autocoding init --ai claude
-# or both
-autocoding init --ai all
+# or claude / all
 ```
 
-2. Initialize docs/tooling:
+2. Initialize docs and local scripts:
 
 ```bash
 python3 .codex/skills/auto-coding-skill/scripts/ap.py --repo . install
@@ -37,22 +34,13 @@ python3 .codex/skills/auto-coding-skill/scripts/ap.py --repo . install
 python3 .claude/skills/auto-coding-skill/scripts/ap.py --repo . install
 ```
 
-3. Fill one config file only:
+3. Fill only one file manually:
 
-- `docs/project/project-config.md`
+- `ENGINEERING.md` frontmatter
 
-This file is the single source for:
-- build/test/lint/typecheck/smoke/regression commands
-- deployment info (ip/user/password/service/path/health)
-- docs paths
+This frontmatter is the only manual config source (commands + deployment + docs paths).
 
-Required Python deps:
-
-```bash
-pip install pyyaml requests
-```
-
-4. Let AI execute workflow by docs constraints:
+4. Start AI development by constraints:
 
 - `ENGINEERING.md`
 - `docs/tasks/taskbook.md`
@@ -64,38 +52,63 @@ pip install pyyaml requests
 
 ## AGENTS.md Constraint Example
 
-Add this in project `AGENTS.md`:
-
 ```md
 ## Mandatory Skill
-- Always use `auto-coding-skill` for every implementation task.
+- Always use `auto-coding-skill` for implementation tasks.
 - Before any code change, read and obey:
   1) ENGINEERING.md
-  2) docs/project/project-config.md
-  3) docs/tasks/taskbook.md
-- Execute gates using `python3 tools/autopipeline/ap.py`.
-- If any required doc is missing, create/update docs first, then code.
+  2) docs/tasks/taskbook.md
+- Execute gates using `python3 scripts/autopipeline/ap.py`.
+- If required docs are missing, create/update docs first, then code.
 ```
 
 ## Commands
 
 ```bash
-python3 tools/autopipeline/ap.py run build
-python3 tools/autopipeline/ap.py run test
-python3 tools/autopipeline/ap.py run lint
-python3 tools/autopipeline/ap.py verify-api-docs
-python3 tools/autopipeline/ap.py check-matrix
-python3 tools/autopipeline/ap.py gen-summary T0001-1
-python3 tools/autopipeline/ap.py commit-push T0001-1 --msg "T0001-1: <summary>" --require-matrix
+pip install pyyaml requests
+python3 scripts/autopipeline/ap.py run build
+python3 scripts/autopipeline/ap.py run test
+python3 scripts/autopipeline/ap.py run lint
+python3 scripts/autopipeline/ap.py verify-api-docs
+python3 scripts/autopipeline/ap.py check-matrix
+python3 scripts/autopipeline/ap.py gen-summary T0001-1
+python3 scripts/autopipeline/ap.py commit-push T0001-1 --msg "T0001-1: <summary>" --require-matrix
+```
+
+## Release New Version
+
+1. Bump version (cannot republish an existing version):
+
+```bash
+npm version patch
+# or: npm version minor
+# or: npm version major
 ```
 
-## Publish
+2. Login and pre-check:
 
 ```bash
 npm login
 npm whoami
 npm run release:check
-npm publish --access public
+```
+
+3. Publish:
+
+```bash
+npm publish --access public --otp <6-digit-otp>
+```
+
+4. Verify release:
+
+```bash
+npm view @elvis1513/auto-coding-skill version
+```
+
+5. Update installed clients:
+
+```bash
+npm install -g @elvis1513/auto-coding-skill@latest
 ```
 
 ## License

package/cli/assets/skill/SKILL.md

@@ -1,6 +1,6 @@
 ---
 name: auto-coding-skill
-description: Use for strict project engineering workflow in Claude/Codex. It initializes docs and enforces taskbook -> design -> implement -> quality gates -> docs -> deploy -> regression -> summary -> commit/push.
+description: Use for strict project engineering workflow in Claude/Codex. Initialize docs, fill ENGINEERING.md frontmatter once, then execute design->implement->gates->summary->commit/push.
 ---
 
 # Auto Coding Skill (Claude + Codex)
@@ -26,19 +26,19 @@ python3 .codex/skills/auto-coding-skill/scripts/ap.py --repo . install
 # or .claude path
 ```
 
-Install runtime deps:
+3) Install runtime deps:
 
 ```bash
 pip install pyyaml requests
 ```
 
-## Single manual config file
+## Single manual config source
 
-Fill only this file:
+Fill only:
 
-- `docs/project/project-config.md`
+- `ENGINEERING.md` frontmatter
 
-YAML frontmatter in this file contains:
+This contains all manual fields:
 - `commands.*`
 - `deployment.*`
 - `docs.*`
@@ -48,22 +48,21 @@ Do not duplicate config in other md/yaml files.
 ## Execution order
 
 1) `ENGINEERING.md`
-2) `docs/project/project-config.md`
-3) `docs/tasks/taskbook.md`
-4) `docs/design/**`
-5) implementation
-6) run gates via `python3 tools/autopipeline/ap.py`
-7) update API docs + regression matrix + bug list + summary
-8) commit/push
+2) `docs/tasks/taskbook.md`
+3) `docs/design/**`
+4) implementation
+5) run gates via `python3 scripts/autopipeline/ap.py`
+6) update API docs + regression matrix + bug list + summary
+7) commit/push
 
 ## Commands
 
 ```bash
-python3 tools/autopipeline/ap.py run build
-python3 tools/autopipeline/ap.py run test
-python3 tools/autopipeline/ap.py run lint
-python3 tools/autopipeline/ap.py verify-api-docs
-python3 tools/autopipeline/ap.py check-matrix
-python3 tools/autopipeline/ap.py gen-summary T0001-1
-python3 tools/autopipeline/ap.py commit-push T0001-1 --msg "T0001-1: <summary>" --require-matrix
+python3 scripts/autopipeline/ap.py run build
+python3 scripts/autopipeline/ap.py run test
+python3 scripts/autopipeline/ap.py run lint
+python3 scripts/autopipeline/ap.py verify-api-docs
+python3 scripts/autopipeline/ap.py check-matrix
+python3 scripts/autopipeline/ap.py gen-summary T0001-1
+python3 scripts/autopipeline/ap.py commit-push T0001-1 --msg "T0001-1: <summary>" --require-matrix
 ```

package/cli/assets/skill/data/templates/ENGINEERING.md

@@ -1,3 +1,42 @@
+---
+project:
+  name: ""
+  repo_root: "."
+
+commands:
+  build: ""
+  test: ""
+  lint: ""
+  typecheck: ""
+  format: ""
+  smoke: ""
+  regression: ""
+
+deployment:
+  host: ""
+  ssh_port: 22
+  username: ""
+  password: ""
+  service_name: ""
+  systemd_dir: "/usr/lib/systemd/system"
+  remote_app_root: ""
+  remote_jar_path: ""
+  remote_config_dir: ""
+  remote_bin_dir: ""
+  health_base_url: ""
+  health_path: ""
+
+docs:
+  taskbook: "docs/tasks/taskbook.md"
+  design_dir: "docs/design"
+  review_dir: "docs/reviews"
+  api_doc: "docs/interfaces/api.md"
+  api_change_log: "docs/interfaces/api-change-log.md"
+  regression_matrix: "docs/testing/regression-matrix.md"
+  bug_list: "docs/bugs/bug-list.md"
+  summary_dir: "docs/tasks/summaries"
+---
+
 # ENGINEERING.md — AutoPipeline Gates (Source of Truth)
 
 目标：把一次任务固化为不可跳过的流水线：  
@@ -5,63 +44,48 @@
 部署(systemd/jar) → 重启验证 → 按API Markdown全量回归 + 回归矩阵0fail →  
 记录Bug并新增自动化回归 → 任务总结落盘 → commit → push
 
-规则：任一步骤失败或缺产物，禁止进入下一步；**未 push 视为任务未完成**，禁止开始下一个任务/子任务。
+规则：任一步骤失败或缺产物，禁止进入下一步；未 push 视为任务未完成，禁止开始下一个任务/子任务。
 
 ---
 
-## 0. 权威输入与冲突裁决（优先级）
-## 0.1 项目配置（必须，单一入口）
+## 0. 配置填写（必须）
 
-- 所有人工维护信息统一放在：`docs/project/project-config.md`
-- 该文件 YAML frontmatter 中必须包含：
-  - `commands.*`（build/test/lint/typecheck/smoke/regression）
-  - `deployment.*`（ip/用户名/密码/服务名/路径/健康检查等）
-  - `docs.*`（任务本、API文档、回归矩阵、Bug清单、总结目录等路径）
+先填写本文件 frontmatter 中的所有空值（例如 ip/用户名/密码/服务名/路径/命令）。  
+禁止在其他 md/yaml 重复维护这些配置。
 
-任何 gate 只允许使用该文件中的配置执行，禁止在其他 md/yaml 再维护一份配置。
+---
 
+## 1. 权威输入与冲突裁决（优先级）
 
 1) ENGINEERING.md（本文件）  
-2) docs/project/project-config.md  
-3) docs/tasks/taskbook.md  
-4) docs/design/**  
-5) docs/interfaces/api.md  
-6) docs/interfaces/api-change-log.md  
-7) docs/testing/regression-matrix.md（必须 0 FAIL）  
-8) docs/bugs/bug-list.md（长期积累，回归必测）  
-9) docs/tasks/summaries/**（每任务一份，强制产物）  
-10) docs/deployment/**  
-11) 代码实现（不得反向覆盖 1~10）
+2) docs/tasks/taskbook.md  
+3) docs/design/**  
+4) docs/interfaces/api.md  
+5) docs/interfaces/api-change-log.md  
+6) docs/testing/regression-matrix.md（必须 0 FAIL）  
+7) docs/bugs/bug-list.md（长期积累，回归必测）  
+8) docs/tasks/summaries/**（每任务一份，强制产物）  
+9) docs/deployment/**  
+10) 代码实现（不得反向覆盖 1~9）
 
 ---
 
-## 1. Gate 流水线（强制、不可跳过）
+## 2. Gate 流水线（强制、不可跳过）
 
 Gate-1 读任务：只从 taskbook 取范围与验收；缺信息先补 taskbook  
-Gate-1.5 配置确认：先补齐 `docs/project/project-config.md`；未补齐禁止进入实现  
 Gate-2 写DD：无DD禁止写代码；DD必须含 时序图/ER图/接口时序（Mermaid）  
 Gate-3 实现：严格按DD；接口变更必须同步 API Markdown  
-Gate-4 本地CI：必须通过（ci-local）  
+Gate-4 本地CI：必须通过（commands.build / commands.test）  
 Gate-5 静态分析+Review：静态分析通过；docs/reviews/ 生成记录  
 Gate-6 文档：更新 api.md + 追加 api-change-log.md  
-Gate-7 部署：单机 systemd/jar；允许 root+密码；service目录固定 /usr/lib/systemd/system；只保留1份备份；失败自动回滚  
+Gate-7 部署：单机 systemd/jar；service目录固定 /usr/lib/systemd/system；失败自动回滚  
 Gate-8 重启+健康：restart后必须健康检查通过  
-Gate-9 全量回归：按 API Markdown 全量回归；回归矩阵（`docs/testing/regression-matrix.md`）全量 PASS（0 fail）；发现问题必须写 bug-list 并新增自动化回归用例（纳入 Gate-9）  
-Gate-10 任务总结：必须生成 docs/tasks/summaries/<TASK_ID>.md（可用工具生成初稿）  
-Gate-11 完成：全门禁通过后必须 commit+push（未push=未完成）
-
----
-
-## 2. 部署约束（来自你的固定要求）
-
-- 允许 sshpass / 或 python 从 `docs/project/project-config.md` 读取 root 密码（非交互）
-- systemd 目录固定：/usr/lib/systemd/system
-- 只保留一个最新备份（*.bak / *.tgz.bak），失败自动回滚并重启服务
-- 健康检查端点不固定：`docs/project/project-config.md` 的 deployment.health_* 字段配置
-- 部署可更新项：app/config/、app/bin/、/usr/lib/systemd/system/*.service、jar
+Gate-9 全量回归：按 API Markdown 全量回归；回归矩阵全量 PASS（0 fail）；发现问题必须写 bug-list 并新增自动化回归用例  
+Gate-10 任务总结：必须生成 docs/tasks/summaries/<TASK_ID>.md  
+Gate-11 完成：全门禁通过后必须 commit+push
 
 ---
 
-## 3. Repo 工具入口（建议）
+## 3. Repo 工具入口
 
-统一用 `python3 tools/autopipeline/ap.py <command>` 执行。
+统一用 `python3 scripts/autopipeline/ap.py <command>` 执行。

package/cli/assets/skill/data/templates/docs/deployment/deploy-runbook.md

@@ -1,6 +1,6 @@
 # Deploy Runbook（单机 systemd / jar）
 
-部署参数统一读取：`docs/project/project-config.md`
+部署参数统一读取：`ENGINEERING.md` frontmatter
 - deployment.host / deployment.ssh_port / deployment.username / deployment.password
 - deployment.service_name / deployment.systemd_dir
 - deployment.remote_app_root / deployment.remote_jar_path / deployment.remote_config_dir / deployment.remote_bin_dir

package/cli/assets/skill/data/templates/docs/reviews/_TEMPLATE-REVIEW.md

@@ -1,7 +1,7 @@
 # Review — <Task ID> — YYYY-MM-DD HH:MM
 
 ## 1. 静态分析结果（必须）
-- Command：lint + typecheck（来自 docs/project/project-config.md）
+- Command：lint + typecheck（来自 ENGINEERING.md frontmatter）
 - Summary：
 - Issues：
 - Resolved/Deferred（deferred 必须给出后续任务）：

package/cli/assets/skill/data/templates/docs/tasks/summaries/_TEMPLATE-TASK-SUMMARY.md

@@ -28,7 +28,7 @@
 - 回滚方式：
 
 ## 5. 质量门禁证据（必须可追溯）
-- 项目配置：`docs/project/project-config.md`
+- 项目配置：`ENGINEERING.md`（frontmatter）
 - 本地CI：`ci-local`
 - 静态分析：`static`
 - Review 文档：`docs/reviews/<TASK_ID>-<timestamp>.md`

package/cli/assets/skill/data/templates/docs/tasks/taskbook.md

@@ -18,7 +18,7 @@
   - [ ] T0001-2 <subtask>
 
 ### 证据（完成后填写）
-- 项目配置：`docs/project/project-config.md`
+- 项目配置：`ENGINEERING.md`（frontmatter）
 - DD：`docs/design/T0001-<slug>.md`
 - Review：`docs/reviews/T0001-YYYYMMDD-HHMM.md`
 - API 文档：`docs/interfaces/api.md`

package/cli/assets/skill/scripts/ap.py

@@ -26,13 +26,13 @@ def cmd_install(args: argparse.Namespace) -> None:
     if args.bridges:
         copy_tree(templates / "bridges", repo)
 
-    tools_dir = repo / "tools" / "autopipeline"
-    tools_dir.mkdir(parents=True, exist_ok=True)
-    copy_tree(Path(__file__).resolve(), tools_dir / "ap.py")
-    copy_tree(Path(__file__).resolve().parent / "core.py", tools_dir / "core.py")
+    scripts_dir = repo / "scripts" / "autopipeline"
+    scripts_dir.mkdir(parents=True, exist_ok=True)
+    copy_tree(Path(__file__).resolve(), scripts_dir / "ap.py")
+    copy_tree(Path(__file__).resolve().parent / "core.py", scripts_dir / "core.py")
 
     gi = repo / ".gitignore"
-    secret_line = "docs/project/project-config.md"
+    secret_line = "ENGINEERING.md"
     if gi.exists():
         txt = gi.read_text(encoding="utf-8")
         if secret_line not in txt:
@@ -41,11 +41,10 @@ def cmd_install(args: argparse.Namespace) -> None:
         gi.write_text(secret_line + "\n", encoding="utf-8")
 
     print(f"[install] OK: scaffold installed into {repo}")
-    print("[install] Next: edit docs/project/project-config.md and fill all project/env fields")
+    print("[install] Next: edit ENGINEERING.md frontmatter and fill all project/env fields")
 
 
-def _infer_title(repo: Path, task_id: str) -> str:
-    taskbook = repo / "docs" / "tasks" / "taskbook.md"
+def _infer_title(taskbook: Path, task_id: str) -> str:
     if not taskbook.exists():
         return "<Title>"
     for line in taskbook.read_text(encoding="utf-8").splitlines():
@@ -62,16 +61,18 @@ def cmd_gen_summary(args: argparse.Namespace) -> None:
     task_id = args.task_id
     cfg = _load_cfg(repo)
     docs_cfg = (cfg.get("docs") or {})
+    taskbook = Path(repo, str(docs_cfg.get("taskbook", "docs/tasks/taskbook.md")))
+    summary_dir = Path(repo, str(docs_cfg.get("summary_dir", "docs/tasks/summaries")))
     api_change_log = str(docs_cfg.get("api_change_log", "docs/interfaces/api-change-log.md"))
     regression_matrix = str(docs_cfg.get("regression_matrix", "docs/testing/regression-matrix.md"))
 
-    out_dir = repo / "docs" / "tasks" / "summaries"
+    out_dir = summary_dir
     out_dir.mkdir(parents=True, exist_ok=True)
     out_file = out_dir / f"{task_id}.md"
     if out_file.exists() and not args.force:
         raise APError(f"Summary already exists: {out_file} (use --force to overwrite)")
 
-    title = _infer_title(repo, task_id)
+    title = _infer_title(taskbook, task_id)
     date = _dt.date.today().isoformat()
 
     staged = run(["git", "diff", "--cached", "--name-only"], cwd=repo, check=False).stdout.strip()
@@ -163,7 +164,7 @@ def cmd_run(args: argparse.Namespace) -> None:
     """
     Run a configured gate command:
       build | test | lint | typecheck | format | smoke | regression
-    Commands are read from docs/project/project-config.md frontmatter.
+    Commands are read from ENGINEERING.md frontmatter.
     """
     repo = Path(args.repo).resolve()
     cfg = _load_cfg(repo)
@@ -172,7 +173,7 @@ def cmd_run(args: argparse.Namespace) -> None:
     if name not in commands:
         raise APError(
             f"Command not configured: commands.{name}. "
-            "Edit docs/project/project-config.md. "
+            "Edit ENGINEERING.md frontmatter. "
             f"Available: {', '.join(commands.keys()) or '(none)'}"
         )
     cmd = str(commands[name])
@@ -197,15 +198,18 @@ def cmd_verify_api_docs(args: argparse.Namespace) -> None:
 def cmd_commit_push(args: argparse.Namespace) -> None:
     repo = Path(args.repo).resolve()
     ensure_git_repo(repo)
+    cfg = _load_cfg(repo)
+    docs_cfg = (cfg.get("docs") or {})
+    summary_dir = Path(repo, str(docs_cfg.get("summary_dir", "docs/tasks/summaries")))
 
     task_id = args.task_id
     msg = args.msg
 
-    summary = repo / "docs" / "tasks" / "summaries" / f"{task_id}.md"
+    summary = summary_dir / f"{task_id}.md"
     if not summary.exists():
         raise APError(
             f"Task summary missing: {summary}\n"
-            f"Generate: python3 tools/autopipeline/ap.py gen-summary {task_id}"
+            f"Generate: python3 scripts/autopipeline/ap.py gen-summary {task_id}"
         )
 
     if args.require_matrix:

package/cli/assets/skill/scripts/core.py

@@ -97,15 +97,14 @@ def http_get_status(url: str, timeout_s: int = 5) -> int:
 def find_config(repo: Path) -> Path:
     """Find single source project config file."""
     candidates = [
-        repo / "docs" / "project" / "project-config.md",
-        repo / "project-config.md",
+        repo / "ENGINEERING.md",
     ]
     for c in candidates:
         if c.exists():
             return c
     raise APError(
-        "Project config not found. Create docs/project/project-config.md "
-        "and put all commands + deployment fields in YAML frontmatter."
+        "Project config not found. Create ENGINEERING.md "
+        "and put commands + deployment fields in YAML frontmatter."
     )
 
 

package/cli/src/index.js

@@ -64,7 +64,7 @@ function resolveTargetDir(ai, mode, destOverride){
 
 function ensureGitignore(projectDir){
   const gi = path.join(projectDir, ".gitignore");
-  const line = "docs/project/project-config.md";
+  const line = "ENGINEERING.md";
   if (!exists(gi)) {
     fs.writeFileSync(gi, `${line}\n`, "utf-8");
     return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elvis1513/auto-coding-skill",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "CLI installer for auto-coding-skill (Claude Code + Codex CLI).",
   "type": "module",
   "bin": {

package/cli/assets/skill/data/templates/docs/project/project-config.md

@@ -1,45 +0,0 @@
----
-project:
-  name: "fill-project-name"
-  repo_root: "."
-
-commands:
-  build: "fill-build-command"
-  test: "fill-test-command"
-  lint: "fill-lint-command"
-  typecheck: "fill-typecheck-command"
-  format: "fill-format-command"
-  smoke: "fill-smoke-command"
-  regression: "fill-regression-command"
-
-docs:
-  taskbook: "docs/tasks/taskbook.md"
-  design_dir: "docs/design"
-  review_dir: "docs/reviews"
-  api_doc: "docs/interfaces/api.md"
-  api_change_log: "docs/interfaces/api-change-log.md"
-  regression_matrix: "docs/testing/regression-matrix.md"
-  bug_list: "docs/bugs/bug-list.md"
-  summary_dir: "docs/tasks/summaries"
-
-deployment:
-  host: "fill-ip-or-domain"
-  ssh_port: 22
-  username: "fill-username"
-  password: "fill-password"
-  service_name: "fill-service-name"
-  systemd_dir: "/usr/lib/systemd/system"
-  remote_app_root: "fill-remote-app-root"
-  remote_jar_path: "fill-remote-jar-path"
-  remote_config_dir: "fill-remote-config-dir"
-  remote_bin_dir: "fill-remote-bin-dir"
-  health_base_url: "fill-health-base-url"
-  health_path: "/health"
----
-
-# Project Config（唯一人工维护入口）
-
-规则：
-1) 所有需要人工维护的项统一写在本文件 frontmatter。
-2) 其他 docs 不再重复维护配置，统一引用本文件。
-3) 开发前先补齐本文件，再启动任何 Gate。