3f3a5cc50be55065b11276534427a7f12fb92e5a
CI / docs-build (push) Successful in 1m29s
`api_key=volcengine.api_key` 这类**依赖注入传参**被 KEY-ASSIGN 判为疑似凭证。 这是规则的真缺口而非代码问题:行里没有任何秘密,而做 DI 的代码到处都是这种 写法——绕过一次就得在每个调用点绕过,那等于把规则废掉。故改规则。 新增 ALLOW_REFERENCE,刻意收得很紧以免开后门: - 值必须是**未加引号**的小写起首标识符引用(真密钥要么带引号,要么不是标识符形状) - 只允许**恰好一个点且随即行尾** - 连字符不在字符集内 对抗性夹具验证(三真三假): - 拦下 `api_key = "sk-T3Blbk…"`(OpenAI 形态) - 拦下 `secret_key: "AKID…"`(腾讯云形态) - 拦下 `auth_token=eyJ….eyJ….Sfl…`(**三段式 JWT——两个点,故不落进放行**) - 放行 `api_key=lowercase.reference` / `api_key = settings.api_key` / `api_token: config.authToken` 原 5 形态泄漏夹具复验仍 8 条命中,一条不少。 另更正口径:脚本头与 git-workflow.md 仍写「三仓同构」,实际已是四仓—— patbond-ai 是唯一持有 AI 服务商凭证的仓,漏同步它风险最大。四仓 md5 已一致 (4945940093b4b8413b7d3eec8bf6a5ec),四仓 --all 全绿。 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Patbond Doc
Patbond 的契约、架构决策与开发过程文档。用 MkDocs 构建成站点。
本仓是四仓中唯一的「正典」所在:契约、数据模型、架构决策以此为准。其余仓库中的同类内容都是副本或实现,冲突时以本仓为准。
权威文档在哪
| 文档 | 位置 | 说明 |
|---|---|---|
| 对外契约 | docs/api/openapi.yaml |
客户端可见的全部端点。升版须与 patbond-api 内的四份快照同步 |
| 数据模型正典 | docs/database/patbond_postgresql.sql |
已评审的目标模型。Flyway 迁移从中逐列摘取,任何偏离都必须在迁移文件头写明原因 |
| 架构决策 | docs/architecture/decisions.md |
ADR-001 起累积。改动实现前先读相关 ADR |
| 后端模块结构 | docs/architecture/backend-modules.md |
各模块职责与边界 |
| 发布记录 | docs/development/releases.md |
每次发布追加一条,含门禁结果与生效的流程纪律 |
| 功能清单 | docs/development/feature-checklist.md |
逐条功能的完成状态 |
| Git 与门禁 | docs/development/git-workflow.md |
分支、提交、CI 门禁与凭证防泄漏规范 |
| 真机验证清单 | docs/development/device-verification.md |
桌面不可替代的验证项,含逐项步骤与通过标准 |
| 服务器暴露面 | docs/development/server-exposure.md |
生产主机的端口、常驻服务与处置记录 |
| 迭代报告 | docs/development/iterations/ |
按迭代归档。存档不回改,结论失效时追加带日期的修正注记 |
本地构建
pip install mkdocs
mkdocs serve # http://127.0.0.1:8000
本地门禁
与 CI 同一套命令(.gitea/workflows/ci.yml):
sh scripts/check-secrets.sh --all # 凭证防泄漏(ADR-021)
mkdocs build --strict # 必须 exit 0 且零 warning
--strict 会把死链和未挂导航的孤立文档判为失败,所以新增文档必须同时挂进 mkdocs.yml 的 nav。
每人每仓启用一次 pre-commit 钩子:
git config core.hooksPath scripts/hooks
scripts/check-secrets.sh 是四仓同构副本,调整规则时四仓同步提交。
写作纪律
- 常设文档不写死本机绝对路径,用
<你的工作区>/patbond-xxx之类的参数化写法;迭代报告存档豁免。 - 迭代报告是时点存档,不回改。结论后来被推翻时,在原文下方追加带日期的修正注记并指向新依据——改掉原文等于销毁历史记录,而追加注记同样能掐断转述链。
- 不要引用别的报告的转述结论。本项目已多次因此误判:某报告写「无 nickname 字段」实指「契约未暴露」,被下游当成「缺列需迁移」,规模预估高估一整档。凡「XX 不存在 / XX 缺失」的判断,请打开原始 SQL、原始契约、原始源码确认,并注明核实的文件与行号。
site/是构建产物,已被.gitignore排除,不要提交。
相关仓库
| 仓库 | 内容 |
|---|---|
patbond-api |
Spring Boot 多模块后端 |
patbond-flutter |
Flutter 客户端 |
patbond-ai |
AI 生成服务(Python),只调服务商 API |
Description
Languages
Shell
100%