wandering1/STM32F4-Base
1
0
Fork 0
Code Issues 30 Pull Requests Actions Packages Projects 2 Releases Wiki Activity
Files
68cbf8ea75130f5ec958defdfe6b957c2e3fdd9f
STM32F4-Base/scripts/README.md
T
wandering1 e25e51c378 ci(A-5): 体积门禁补强制路径——同码凭证 + CI 无需 Keil 复核 92% 红线 
背景：A-5 残余（docs/任务规划/测试与架构专项.md）说得很直白——mem-numbers 在
CI 被跳过（runner 无 Keil/无 .map），上一轮只把"跳过"声明成一条 ::warning::，
"盲区本身未消除"：看到 CI 全绿仍会以为体积也守住了。

复核时本地侧同样漏：ram_baseline.py --gate 在无 .map 时自适应 SKIP 且返回 0；
mem-budget 甚至没进 CI 的 SKIP 名单——它在 runner 上以"Passed"的面貌出现，实际
什么都没检查。两处共同点是**"没跑 = 通过"**。

做法：给体积数字配一条可提交、CI 可复核的**同码凭证**，而不是要求 runner 装 Keil。
- 新增 scripts/check_size_gate.py（口径与边界的唯一正文在其模块 docstring）
  · --stamp：只在三条都成立时才盖章——① .map 存在且解析得出执行区与 Grand
    Totals；② .map 不早于指纹范围内任何源码的 mtime；③ 受管区占比不超过
    mem-budget 用的同一常数。凭证因此不是随手可写的。
  · --local：工作树指纹必须等于凭证指纹，否则 FAIL（="改了代码但体积从没测过"）
  · --ci：不需要 Keil 也能判的两条——同码性 + 按凭证记录的数字复核 92% 红线
  · --show：排障用。指纹 = git ls-files 范围内逐文件 sha256(路径+内容) 再聚合，
    覆盖 App/ Drivers/ Src/ Inc/ Lib/ Middlewares/ test/board/ 与 MDK-ARM 的 .sct/.s
- 新增 scripts/size_attestation.json：本树的凭证（由本树一次真实 @build 盖戳）
- scripts/ram_baseline.py：--update 顺手盖戳——"每次 @build 后跑 --update"是既有
  纪律，不新增人工步骤；在函数内 import 防成环；盖戳失败只告警、不改 --update
  返回值（新鲜度由门禁自己 fail-closed 兜）。_util/_read_tsv 提为公开名
  region_pct / read_tsv_rows 供其复用（体积口径禁第二处定义）；--gate 的无 .map
  文案改成明说"SKIP 不等于 PASS"并指向兜底路径。
- scripts/ci_local.py：新增 L0c 体积门禁步（fail-closed、无条件照跑、约 0.3 s）
  与 --size-only 开关；docstring 里把"无 .map 时跳过两根钩子"的语义补全。
- .gitea/workflows/ci.yml：L0 作业末尾加「体积门禁」步（if: always()，无需 Keil）；
  主干 push 拦红、其余事件 --warn-only（分支上代码尚未定型，拦红只造噪音，还会
  诱发多条道同时抢写 scripts/ 台账）；SKIP 名单补 mem-budget，让它诚实显示
  Skipped 而不是假 Passed；文件头的"门禁盲区声明"改写为"已关闭为强制路径 +
  仍守不住的三项"。run: 块全部纯 ASCII（PS 5.1 无 BOM 按 GBK 解码的实测坑）。
- scripts/README.md：登记新脚本与凭证文件，补用法行。

验证（工作树 _wt/A5-size-gate，分支 task/A5-size-gate）
- @build 0 错 0 警：Code=213780 RO=18860 RW=1204 ZI=131852——与 ram_baseline.tsv
  的 2026-10-24 行逐项相同（本改动不碰固件源码，指纹不变，零体积增量）。
- 门禁实跑全 0：check-yaml / trailing-whitespace / end-of-file-fixer /
  check-added-large-files / no-mojibake / id-check / doc-links / mem-budget。
- 负向 8 例全过：改凭证指纹 → --local 与 --ci 都 rc=1；凭证占比改成 95% →
  --ci rc=1，加 --warn-only 则 rc=0；凭证写成非法 JSON → rc=1；用 mtime 回拨的
  .map 去 --stamp → 拒绝且不动凭证；把区 max 改小到必然超线再 --stamp → 同样拒绝。
- 正向：--stamp 之后 --local / --ci 均 rc=0，并与 tsv 末行互证同源。
- --update 的盖戳联动单独验（把 TSV_PATH 与凭证指到仓库内已 gitignore 的
  ci-artifacts/ 探针文件，跑完清理，本树台账未被测试污染）。
- ci_local 全量：L0.5 33 runner / 2227 断言全绿、gitlint 10/10、L0c rc=0。L0 里
  test-cppcheck 与 test-coverage 各报过一次"files were modified"——单独重跑两条
  均 rc=0 且工作树无改动，判定为三条道并行跑主机单测时 %TEMP% 里按套件名派生
  的 obj/exe 互相踩踏（harness 产物名全机共用一个 TEMP 目录），非本改动引入。

RAM 增量：0 B（未动固件源码，凭证数字与本树一次真实链接一致）。
gate：全部通过，未使用 --no-verify。

遗留 / 需要 lead 裁定
1. 合入后主干 push 会要求"同码测量"：done 流程在 @build 0/0 之后要多跑一条
   python scripts/ram_baseline.py --update，并把 scripts/size_attestation.json
   （数字变了则连 scripts/ram_baseline.tsv）一并提交。这就是"强制"的含义，但
   确实新增半步——若你想先只在本地强制（L0c），我把 CI 那步改成 --warn-only。
2. 文档口径同步我没做（docs/任务规划/**、docs/门禁说明/**、docs/CI/README.md
   归主树）：A-5 销项时建议把"CI 不守体积"改为"CI 守同码性 + 红线，绝对数字仍
   由本地真实构建产生"，正文引用 check_size_gate.py 的模块 docstring。
3. 编译器选项（uvprojx）刻意不进指纹：UV4 每次构建改写它且不入库，进指纹会让
   门禁在"刚刚构建完"的那一刻自己变红；代价是改优化等级/宏不触发本门禁，需人工
   重测——已写进边界正文。
2026-10-25 03:51:19 +08:00

9.1 KiB
Raw Blame History

scripts/ — 开发脚本（提交门禁 + 报告生成）

本目录是 pre-commit 门禁脚本与报告生成脚本的存放处。 与 tools/（面向开发者的功能工具）区别：本目录服务于质量门禁与工程度量。

文件一览

提交门禁（接入 .pre-commit-config.yaml）

脚本 钩子名 作用
check_coding_standard.py C coding standard C 代码规范机械检查（命名前缀/常量右置/头文件保护宏等）
check_mojibake.py Forbid U+FFFD mojibake 扫描 U+FFFD 乱码（EF BF BD 字节）
check_doc_links.py doc-links 文档链接存在性 + 命名规范（D-3/D-7）+ §N.M 章节引用（口径见 docs/文档规范.md §3.5）。钩子已带 --sections-strict（自引用失效也拦）；--section-todo 列出机器判不了目标的 §（带改写建议）。每次跑打印「可判定比例」行，防覆盖率回落
section_aliases.json （被 check_doc_links.py 读） 文档昵称别名表：「内存方案」→ docs/内存管理/RAM使用分析与优化方案.md。只登记无歧义昵称；登记一次即把该昵称的引用纳入硬门禁
check_ids.py id-check 编号门禁：docs/编号规范.md §8 的八项校验（未登记前缀 / 形态 / 悬空 / 重复定义 / 越游标 / 未紧邻文档名 / 孤儿 / 可判定比例）。已关闸为增量拦截：钩子带 --strict，只拦 scripts/id_known_backlog.json 台账之外的新错误级问题（存量按指纹豁免、台账只减不增）；可判定比例跌破基线任何模式都失败。详表（含限制与盲区）→ docs/门禁说明/id-check.md
id_registry.json （被 check_ids.py 读） 前缀族注册表：属主登记处 / 形态正则 / 冻结 / 游标，逐项来自 docs/编号规范.md §4；decidable_ratio_baseline = 校验 8 的基线（只许涨）。与 section_aliases.json 同一套"别名表 + 可判定比例"范式
id_aliases.json （被 check_ids.py 读） 编号别名/作废表：旧字面量 → 现行字面量或 status: void（如 N-32 销项后仍被引用、T-4 随销项永久作废、模块码 PHY→NET）
check_test_traceability.py （被 id-check 顺带调用） TC 用例双向追溯：文档 ↔ 代码两侧的 TC 编号集合比对；2026-10-20 起范围扩到 test/host/ 与 7 篇「单元测试说明.md」（--board-only 回退旧板级口径）。此前该脚本未挂任何钩子
gen_task_table.py task-table FreeRTOS 任务表以 Src/freertos.c 为唯一事实源生成/校验（D-2/D-7）
check_mem_numbers.py mem-numbers 内存/Flash 数字以 .map 为唯一事实源校验（D-7 体积档）
check_test_suite.py test-suite-switch 测试套件开关=产品构建（防测试固件静默提交）

报告生成（非门禁）

脚本 作用
ram_report.py 从 .map 生成静态 RAM/Flash 占用报告（→ docs/内存管理/data/）
stack_report.py 从 Keil 静态调用图 + 串口 [STACK] 水位生成每任务最坏链报告

引用同步（改名 / 挪目录）

脚本 作用
rename_ids.py 编号（字面量）批量改名：映射表 JSON 驱动，files 显式 scope（同一裸形字面量可能属多族，实测 S3 三义 → 全局替换必造新撞号）；默认干跑，--apply 落盘并自动写 id_aliases.json 的 scoped 旧号→新号条目；[示例]/[计划] 行与变更记录表不改写；按原字节读写（保 BOM 与行尾）。用法与批次记录 → docs/编号规范.md §8.3
rename_ref.py 改名/挪目录 + 全库引用自动改写：默认 dry-run 预览，--apply 才落盘（git mv → 改写引用 → 自动跑 check_doc_links --all 复核）。覆盖反引号引用、Markdown 链接、图片 ../ 层级换算、#include、uvprojx/CMakeLists.txt 源列表。固定动作与边界 → docs/文档规范.md §3.6

check_doc_links.py 除链接存在性外，还校验 §N.M 章节引用是否指向目标文档真实存在的编号标题（口径见 docs/文档规范.md §3.5）。

CI 与本地等价（2026-10-01 T-6）

脚本 / 文件 作用
ci_local.py 本地跑与 CI 等价的门禁（L0 pre-commit + L0b 提交信息 + L0c 体积门禁 + L0.5 主机侧单测）：自动选用装了 pre-commit 的解释器；无 .map 时自适应跳过 mem-numbers / mem-budget（⚠ 那是 SKIP 不是通过，缺口由 L0c 兜住）；退出码 0/1/2 与 CI 对齐。CI 定义见 ../.gitea/workflows/ci.yml，覆盖边界见 docs/测试说明/测试开发标准流程.md §9
check_size_gate.py 体积门禁的强制路径（A-5 残余）：.map 只在本地有，钩子无它时自适应 SKIP，于是"没测=通过"。本脚本用已提交的同码凭证 scripts/size_attestation.json 把这条判据变成无需 Keil 也能跑：--stamp 只在".map 存在、比全部受管源码新、且未超 92%"时才盖章（已挂在 ram_baseline.py --update 里，无新增人工步骤）；--local 供 ci_local 的 L0c 步；--ci 供 runner（同码性 + 按凭证数字复核红线，主干 push 拦红、其余事件 --warn-only）；--show 排障。口径与边界的唯一正文在本脚本模块 docstring
size_attestation.json （被 check_size_gate.py 读写）体积同码凭证：受管源码指纹（git ls-files 范围内逐文件 sha256 聚合）+ 测量数字与占比 + .map 出处。改固件源码后不重测 → 指纹对不上 → L0c 与 CI 同时拦红
check_test_coverage.py 主机单测覆盖率（2026-10-23）：mscoverage 动态插桩跑 test/host/** 全部 16 套，统计自研生产源码行/函数覆盖（并集）+ 与 test_coverage_baseline.json 比回退；--module/--update-baseline/--md/--json/--list；不在 pre-commit 里，入口是 ci_local.py --coverage（口径见 docs/测试说明/主机单测覆盖率口径.md）
ci_gitlint_range.ps1 CI 侧提交信息门禁：逐条校验本次 push/PR 引入的提交（--all-files 跑不到 commit-msg stage，故必须单独守）
ci_find_python.ps1 CI 侧 Python 探测（候选顺序须与 ci_local.py 同序同步，否则 CI 与本地判定会分叉）
ci_runner_bootstrap.ps1 本机 runner 运维脚本（体检 -Status / 干跑 -DryRun / 部署 -SetEnv -StartNow）：装"等 Gitea 就绪 + 崩溃自拉起"的看门狗 + 开机计划任务 + 机器级 DTU_*

⚠️ 后三个脚本是本机 runner 专属运维（远程 CI 只跑在本机一台机器上），用法、原理与 踩坑全部集中在 docs/CI/README.md，本表只登记不展开。

使用方式

# 全库跑门禁（用仓库 .venv 的 python，其 pre-commit 随 requirements.txt 安装；
# 其他装有 pre-commit 的解释器可用 DTU_PRECOMMIT_PYTHON 指定）
& '.venv\Scripts\python.exe' -m pre_commit run --all-files

# 本地跑与 CI 等价的门禁（L0 + L0b + L0c + L0.5）
& '.venv\Scripts\python.exe' scripts/ci_local.py
& '.venv\Scripts\python.exe' scripts/ci_local.py --l0-only    # 只跑 L0
& '.venv\Scripts\python.exe' scripts/ci_local.py --l05-only   # 只跑 L0.5
& '.venv\Scripts\python.exe' scripts/ci_local.py --size-only  # 只跑 L0c 体积门禁（A-5 强制路径）
& '.venv\Scripts\python.exe' scripts/check_size_gate.py --show   # 体积同码凭证现状（0.3 s，无需 Keil）
& '.venv\Scripts\python.exe' scripts/check_size_gate.py --stamp  # 用新鲜 .map 重新盖戳（--update 已自动带做）

# 单个脚本
& '.venv\Scripts\python.exe' scripts/check_doc_links.py --all
& '.venv\Scripts\python.exe' scripts/rename_ref.py docs/旧/名.md docs/新/名.md          # 预览
& '.venv\Scripts\python.exe' scripts/rename_ref.py docs/旧/名.md docs/新/名.md --apply  # 落盘
& '.venv\Scripts\python.exe' scripts/gen_task_table.py --check   # 或 --write / --diff
& '.venv\Scripts\python.exe' scripts/check_mem_numbers.py --check
& '.venv\Scripts\python.exe' scripts/check_test_suite.py               # 门禁判定
& '.venv\Scripts\python.exe' scripts/check_test_suite.py --allow-test-build  # 放行测试构建
& '.venv\Scripts\python.exe' scripts/ram_report.py
& '.venv\Scripts\python.exe' scripts/stack_report.py -s .dsh\skills\serial-assistant\scripts\state\serial.log

⚠️ 脚本编写约定

  • 保真回写：改文件前先探测原换行符（LF/CRLF）与 BOM，按原样回写（本仓库各文件换行混杂）
  • 受管区锚点：改文档中的数值/表格时用 <!-- XXX:BEGIN/END --> 锚点，只替换锚点内内容
  • 脚本输出文件绝不能落在自身扫描范围内（否则会"自我污染"，见 docs-tree-reorg skill）
  • 生成器与校验器共用同一套正则/口径，避免两处数字打架

相关文档

  • docs/代码规范/pre-commit使用说明.md — 门禁完整说明与排除项
  • docs/代码规范/cppcheck使用说明.md
  • docs/文档规范.md — 文档门禁三档
  • docs/内存管理/RAM使用分析与优化方案.md — RAM/栈报告口径
Reference in New Issue View Git Blame Copy Permalink