# gongkong/config.yaml.example — 项目专属配置模板（无敏感信息）
#
# ⚠️ 安全警告
# 1. 复制本文件为 config.yaml 后再填写真实值。
# 2. config.yaml 已被 .gitignore 排除，禁止手动添加进 Git。
# 3. 敏感凭据（密码/Token/私钥）优先通过环境变量注入，不要明文写在本文件。
# 4. Skill 只会读取 config.yaml 的路径和内容，不会把凭据上传或展示在对话中。
# 5. 如果你误将含真实凭据的 config.yaml 提交到仓库，请立即轮换所有凭据。
#
# 用法：
#   cp config.yaml.example config.yaml
#   # 编辑 config.yaml 填入项目专属值
#   # 敏感字段填环境变量名，运行前 export 对应变量
#
# ===== 注释规范（本文件是给 AI 读的，必须遵守） =====
# 教训（2026-09-10，千问3.5 实测）：弱模型不会跨段关联结论——解释写在 A 段、
# 占位符出现在 B 行，模型在 B 行只看到「待填的值」，会把占位符当待办去补全
# （实例：topology=local 的项目，模型看到 ssh.alias 占位符，不去援引 local 结论，
# 反而去配 ~/.ssh/config、找真实 IP）。
# 规则：
# 1. 占位符/空值/非直觉值，必须在「同一行或紧邻上一行」标注三件事：
#    这是什么状态（故意留空 or 待填）、是不是待办、该怎么处理。
# 2. 禁令（禁止 SSH / 禁止删 / 只读 等）写在「会出错的那个字段旁边」，
#    不要只写在另一段落里指望模型自己找。
# 3. 环境变量引用（*_from_env）不是空值，是真实引用，行尾注明 export 方法即可。

# 可选：显式继承全局或父级配置
# 典型场景：
#   - monorepo 子项目继承根项目通用字段（SSH/Gitea）
#   - 独立项目删除本行，完全自治
# extends: ~/.trae/gongkong/global.yaml

project:
  name: 你的项目名
  root: /path/to/your/project

git:
  gitea_url: https://your-gitea.example.com
  # 服务器代码按内容性质分仓库存放，按需增减
  repositories:
    - name: server-code
      local_path: /server-git/code
      description: 自研代码

    - name: server-config
      local_path: /server-git/config
      description: 服务器配置

    - name: server-web
      local_path: /server-git/web
      description: 前端站点

ssh:
  # 仅 deploy.topology: remote 时填真实值。
  # topology: local（生产在本机）时保持下面占位符，并保留行内「勿用」标注——
  # 占位符是故意留空、不是待办：禁 ssh 连接、禁配 ~/.ssh/config、禁找真实 IP。
  alias: your-alias          # remote: ~/.ssh/config 中的别名；local: 保持占位符·勿用（生产在本机，无需 SSH）
  host: your.server.ip       # remote: 服务器 IP；local: 保持占位符·勿用
  port: 22
  user: your_user
  key: your_ssh_key_name

deploy:
  # topology 决定 ssh 段是「真填」还是「故意留空」：
  #   local  = 生产就在本机（nginx alias 指向本地目录），无远程服务器，
  #            查生产库/nginx/日志一律本机直接执行。
  #   remote = 生产在远程服务器，上面 ssh 段必须填真实值。
  topology: local            # local | remote
  # 部署根目录：local 形态=本机生产副本路径（如 /opt/xxx/）；remote 形态=服务器路径
  remote_root: /path/to/deploy/root/
  # 部署工具脚本（解决 heredoc/引号问题的 base64 传输方案）
  # 位置：项目根目录下的 remote.ps1（或等效部署脚本）
  remote_ps1: remote.ps1
  # 部署优先级: remote_ps1 upload > remote_ps1 run > ssh > 项目配置的远程执行通道

  # ===== 部署闭环校验 (gongkong 三层防御, 对接 gongce 协议0) =====
  # 来源: 2026-08-21 生产事故 "AI 改完代码不提交/不部署, 服务器跑旧二进制"
  # 目标: 任何使用 gongcheng 的人, 即使完全没听说过这个问题, 也不可能再踩坑
  #
  # health_check_url 必填 (或 declare-skip), 否则 check_probes.py 拒绝放行 deploy
  # 选项1: 填该服务的 /__version__ 探针 URL, 部署后自动 curl 校验 commit==本地 HEAD
  health_check_url: http://127.0.0.1:8080/__version__
  #
  # 选项2: 纯静态/CLI 服务无 HTTP 接口, 显式声明跳过 (必须给原因)
  # health_check_url: declare-skip
  # declare_skip_reason: "pure CLI tool, no HTTP server"
  #
  # 已内置 commit+build+restart+curl 校验+失败回滚 的闭环部署脚本
  # 模板见 gongkong/scripts/templates/build-deploy-{go,python,node}.sh
  build_deploy_script: build-deploy.sh
  #
  # AI 代码项目可选: 强制 ship-check 门禁 (对接 gongce 协议4)
  # ship_check_required: true
  # ship_check_report: docs/test/03_ship_check.md

# 多服务项目 (monorepo) 改用 services[] 列表, check_probes.py 自动适配
# services:
#   - name: token-factory
#     port: 5232
#     health_check_url: http://127.0.0.1:5232/__version__
#     build_deploy_script: token-factory/build-deploy.sh
#   - name: airpg
#     port: 5235
#     health_check_url: http://127.0.0.1:5235/__version__
#     build_deploy_script: airpg/build-deploy.sh
#   - name: cli-tool
#     health_check_url: declare-skip
#     declare_skip_reason: "pure CLI tool, no HTTP server"

memory:
  # gongyi 知识库 SQLite 路径（相对 project.root，按项目目录名命名）
  db_path: .ai/{项目名}.ai.db

# 高风险文件清单（gongyou 协议2 使用）
# 改动前必须经影响检查并等用户确认
# 以下是通用示例，按你的项目结构调整
high_risk_files:
  # 鉴权链路 — 改动可能导致登录失效
  - "src/auth/**"
  - "**/auth/**"
  - "**/middleware/auth*"

  # 数据库迁移 — 改动可能导致数据丢失
  - "src/db/migrations/**"
  - "**/migrations/**"
  - "**/*.sql"

  # 配置文件 — 改动可能导致服务不可用
  - "**/config.{ts,json,js,py}"
  - "**/.env"
  - "**/nginx/**"

  # 前端入口 — 改动可能导致白屏
  - "**/index.html"
  - "**/app.{tsx,jsx,js}"

# 数据库连接清单（gongshu 使用）
# 任何数据库读写操作前，gongshu 会根据此清单连接数据库并进行风险分级
db:
  connections:
    - name: primary
      type: mysql          # mysql / postgresql / sqlite
      host: 127.0.0.1
      port: 3306
      database: your_db
      user: your_user
      # 敏感凭据推荐通过环境变量注入
      password_from_env: DB_PASSWORD
      # 兼容旧项目可保留 password（不推荐）
      # password: <请填写，不提交到 Git>
    # - name: sqlite_local
    #   type: sqlite
    #   path: /path/to/your.db
    # topology: local 的项目建议把生产库也登记进来（本机路径 + readonly），
    # AI 排查生产问题直接命中，不用每次现探路径：
    # - name: prod
    #   type: sqlite
    #   path: /opt/xxx/xxx/prod.db        # 本机生产副本内的库（生产在本机，直接查，禁 SSH）
    #   readonly: true                    # 排查用只读；写操作走 gongshu 数据协议

  # 项目专属敏感字段（追加到 gongshu 默认清单）
  # 默认已包含: password_hash/token/secret/balance/email/phone 等
  # 在此追加项目特有的敏感字段
  sensitive_fields:
    - "custom_secret_field"
    # - "tf_token"
    # - "api_key"

  # 数据库备份目录（gongshu 协议2 使用）
  backup_dir: "/backup/mysql"

  # 数据操作审计日志路径（gongshu 协议3 使用）
  audit_log: "/var/log/ai-data-ops.log"

# ===== 可选扩展字段（项目专属，gongcheng 不强制要求） =====

# 远程执行通道（SSH 失败时的兜底，如 WebSocket 代理、CI runner 等）
# remote_execution:
#   url: ws://127.0.0.1:8090/remote/ws

# 任务派发机制（多任务并行时使用）
# task_dispatch:
#   url: ws://127.0.0.1:8090/dispatch/ws

# 项目关键词映射
# 用于将用户口语映射到具体仓库
keyword_mapping:
  # 示例：用户说"改一下前端" → 映射到 server-web 仓库
  前端: server-web
  后端: server-code
  配置: server-config
  所有: ALL
  全部: ALL

# 前端部署架构（如使用 Nginx 直接指向 Git 目录）
frontend_deploy:
  nginx_location: /your-project/
  nginx_alias: /path/to/your/frontend/
  # Nginx 配置位置（按你的服务器实际情况填）
  nginx_conf: /etc/nginx/nginx.conf
  nginx_binary: /usr/sbin/nginx
  nginx_user: www

# Git 服务管理员信息
# 敏感凭据推荐通过环境变量注入
# 自建 Gitea 时填真实账号密码；公共仓库不要把这个文件提交
git_admin:
  username: your_username
  password_from_env: GIT_ADMIN_PASSWORD
  # 兼容旧项目可保留 password（不推荐）
  # password: <请填写，不提交到 Git>

# 自动快照（每天凌晨自动遍历所有仓库，有修改则自动 commit + push）
auto_snapshot:
  enabled: true
  time: "04:00"
  commit_message_template: "auto-snapshot: [日期] 自动备份"
