jkooe
2bf45fdf98
将《代码审计 → 上线 完整交付方案》v1.0 适配到 nodeagent，产出 docs/DELIVERY-PIPELINE.md，并落地其中可执行的部分。 ## 为什么要适配而不是照搬 原方案面向 Web/容器服务（有服务端、有镜像、有多环境）。nodeagent 是 跑在用户机器上的跨机接管框架，无服务端、无容器、无多环境。照搬会产生 「跑得很好但守不住任何东西」的假门禁。故每个阶段给三档判定： 适用 / 改造后适用 / 不适用（但必须给替代，不允许只写 N/A）。 关键替换： - 容器镜像扫描 → 交付物 PE 架构断言（arm64 包误装 x64 node.exe 的真实事故） - DAST → 协议健壮性测试（本项目对外输入面是 WebSocket RPC，非 HTTP） - dev/staging/prod → 真机矩阵（Win x64/arm64、macOS、Linux） - 金丝雀 → 设备分批自更新（先一台试点，latest.json 灰度） - Prometheus → system.metrics（闭环率/P95/拦截率）+ 发布后复核清单 ## 本次落地 1. 覆盖率门禁 scripts/ci/check-coverage.mjs - 全量**只观测不阻断**（实测基线 66.9%，照搬 80% 全量不现实） - 变更文件行覆盖率 ≥70% 阻断；单测 import 的是 dist/，需 src→dist 映射 - 无覆盖数据的变更文件不阻断，单列供人工判断（算 0% 会让重构无法合入） 2. 提交信息校验 scripts/ci/check-commit-msg.mjs - 项目实际已在用 Conventional Commits，但无强制 → 变成会红的门禁 - 不引 commitlint+husky：本项目只需类型白名单，几十行即可且 CI 本地都能跑 3. .github/workflows/quality-gate.yml：gitleaks + pnpm audit + typecheck + 覆盖率 + 提交规范 4. CI artifact retention-days 30 → 7（公开可下载，留存越久暴露面越大） 5. LKG（最后已知可用版本）apps/agent/src/lkg.ts - 只在**启动成功后**才写，不在更新写完时写（否则等于把未验证版本当已知可用） - 暴露为 system.info.lkg，matches=false 表示当前版本尚未被证明能启动 - 控制端据此暂缓向其余设备放量 ## 刻意不做的事：自动回滚 远程设备上无法区分「更新坏了」与「网络抖动」；自动回滚可能形成回滚循环； 被控端自作主张改自己会让控制端失去掌控。故 LKG 只提供确定的回滚目标， 决策权留给控制端。已在文档中写明取舍理由。 ## 实测证据 - 覆盖率门禁三条故障注入均 exit=1（阈值100 / 全量99 / lcov缺失），正常 exit=0 - 提交规范反例 3 类均红，Merge 与无 scope 正确豁免，历史 20 条提交一次通过 - LKG 新增 8 条单测（含篡改 hash 必须检出 matches=false） - 既有契约测试在新增 lkg 字段后立刻报红（SystemInfo 缺声明），补接口后转绿 —— 这本身是门禁有效的实证 - 全量单测 341 → 349 全绿
109 lines
3.2 KiB
YAML
109 lines
3.2 KiB
YAML
# 交付流水线左移门禁（见 docs/DELIVERY-PIPELINE.md §1 §2 §8）
|
||
#
|
||
# 本文件只做「快且能阻断」的检查：密钥、依赖漏洞、类型、覆盖率、提交规范。
|
||
# 真机链路（install.cmd / control.cmd 双击、Windows 能力）留在 windows-e2e.yml
|
||
# —— 那一环跑得慢但价值最高，不可被这条更快的流水线替代。
|
||
#
|
||
# ⚠️ 阈值说明（别照搬通用 80%）：详见 docs/DELIVERY-PIPELINE.md §2。
|
||
# 全量覆盖率当前基线约 66.9%，故全量只观测；阻断只针对**变更文件**（≥70%）。
|
||
|
||
name: Quality Gate
|
||
|
||
on:
|
||
pull_request:
|
||
branches: [main]
|
||
push:
|
||
branches: [main]
|
||
|
||
permissions:
|
||
contents: read
|
||
|
||
jobs:
|
||
# ① 代码审计：密钥 + 依赖漏洞
|
||
audit:
|
||
name: 代码审计（密钥 + 依赖）
|
||
runs-on: ubuntu-latest
|
||
steps:
|
||
- uses: actions/checkout@v5
|
||
with:
|
||
# gitleaks 扫历史提交，需要完整历史
|
||
fetch-depth: 0
|
||
|
||
# 密钥扫描：nodeagent 的密钥面比一般项目大 ——
|
||
# PSK、Ed25519 私钥、TLS 自签证书、PSK.txt、agent.json
|
||
- name: 密钥与敏感信息扫描
|
||
uses: gitleaks/gitleaks-action@v2
|
||
env:
|
||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||
|
||
- uses: pnpm/action-setup@v4
|
||
|
||
- uses: actions/setup-node@v4
|
||
with:
|
||
node-version: 22
|
||
|
||
- run: pnpm install --frozen-lockfile
|
||
|
||
# 依赖漏洞：High 及以上阻断
|
||
- name: 依赖漏洞扫描（SCA）
|
||
run: pnpm audit --audit-level=high
|
||
|
||
# ② 质量门禁：类型 + 覆盖率
|
||
gate:
|
||
name: 质量门禁（类型 + 覆盖率）
|
||
runs-on: ubuntu-latest
|
||
steps:
|
||
- uses: actions/checkout@v5
|
||
with:
|
||
# 覆盖率门禁要算「变更文件」，需与基线做 diff
|
||
fetch-depth: 0
|
||
|
||
- uses: pnpm/action-setup@v4
|
||
|
||
- uses: actions/setup-node@v4
|
||
with:
|
||
node-version: 22
|
||
|
||
- run: pnpm install --frozen-lockfile
|
||
|
||
- run: pnpm typecheck
|
||
|
||
# 单测 import 的是 dist/（编译产物），必须先构建，否则覆盖率全空
|
||
- run: pnpm -r build
|
||
|
||
- name: 采集覆盖率
|
||
run: |
|
||
mkdir -p coverage
|
||
node --test --experimental-test-coverage \
|
||
--test-reporter=lcov \
|
||
--test-reporter-destination=coverage/lcov.info \
|
||
"tests/unit/**/*.test.mjs"
|
||
|
||
- name: 覆盖率门禁
|
||
run: node scripts/ci/check-coverage.mjs --lcov coverage/lcov.info --base origin/main --threshold 70
|
||
|
||
# coverage/ 已在 .gitignore 中，此处留档便于人工查看
|
||
- uses: actions/upload-artifact@v4
|
||
if: always()
|
||
with:
|
||
name: coverage
|
||
path: coverage/
|
||
retention-days: 7
|
||
|
||
# ③ 提交信息规范
|
||
commits:
|
||
name: 提交信息规范
|
||
runs-on: ubuntu-latest
|
||
if: github.event_name == 'pull_request'
|
||
steps:
|
||
- uses: actions/checkout@v5
|
||
with:
|
||
fetch-depth: 0
|
||
|
||
- uses: actions/setup-node@v4
|
||
with:
|
||
node-version: 22
|
||
|
||
- name: 校验 Conventional Commits
|
||
run: node scripts/ci/check-commit-msg.mjs --base ${{ github.event.pull_request.base.sha }}
|