Phase 2 of docs/modules/rust/PLAN.md. Phase 1 built five guards and ran them by hand; this repo had no workflows at all, so nothing gated the branch that gets released and there was no way to release it. Three pieces: - **release.yml** — the derived-version engine link, installer and Module-uo already run (conventional-commit subjects since the newest tag; module.json's version survives as a floor; workflow_dispatch as the backdoor), assembling the bundle from an include list and publishing the tarball, the install manifest carrying its sha256, and SHA256SUMS. The tag is the number that ships and CI stamps it into the bundle's own module.json. - **pr-checks.yml** — server tests, check:imports, check:bundle, check:swagger, the client build, client tests and check:externals, plus frozen-manifest. - **frozen-manifest** — clones core at the sha pinned in ci/core-ref.json, generates its route table without this module and with it, and takes the difference. It ran locally against that exact ref: six routes, all documented, no core route moved. That is the first proof by a running core that /rust collides with nothing — phase 1 could only check it by reading, because core mounts /status and /version at a tier root where the loader's own collision probe cannot see them. The bundle carries no node_modules, because the shipped half declares no runtime dependencies (org lead, phase 2). checkBundle.js holds both halves of that: the include list still covers everything server/index.js reaches, and no dependency has appeared without the release learning to pack it. Verified by breaking it — dropping "model" from the list names the exact edit and exits 1. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016wDDVXWMDz82WqE1i969r4
48 lines
2.2 KiB
JSON
48 lines
2.2 KiB
JSON
{
|
|
"$comment": [
|
|
"What a release copies into the bundle, declared ONCE. Read by .gitea/workflows/release.yml when",
|
|
"it assembles the tarball, and by server/scripts/checkBundle.js when CI asks whether that list",
|
|
"still covers everything the module's entry point can reach.",
|
|
"",
|
|
"This is an INCLUDE list on purpose. An exclude list ships whatever it forgot: the day someone",
|
|
"adds server/tools/ with a scratch credential in it, an exclude list packs it and nobody finds",
|
|
"out. The cost of that choice is that a new top-level directory silently drops OUT of every",
|
|
"release instead — which is exactly what happened to Module-uo between v0.3.0 and v1.0.0, where",
|
|
"server/commands/ arrived with a cutover, the list did not learn about it, and the module",
|
|
"installed and then died at the register stage on the operator's box. checkBundle.js exists so",
|
|
"that cannot happen twice, and it runs on the PR that adds the directory.",
|
|
"",
|
|
"server[] entries are paths under server/; root[] and generated[] are paths under the module",
|
|
"root.",
|
|
"",
|
|
"node_modules is NOT here, and its absence is asserted rather than assumed: this module declares",
|
|
"no runtime dependencies (everything the shipped half needs arrives on ctx), so the release runs",
|
|
"no npm ci and packs no dependency tree. checkBundle.js fails the PR that adds a `dependencies`",
|
|
"entry to server/package.json without also teaching the release to pack it — because a module",
|
|
"whose bundle silently lacks its own dependency fails the same way the missing directory did.",
|
|
"",
|
|
"generated[] ships but is not copied — release.yml writes module.json through jq to stamp the",
|
|
"released version into it, since the committed one is a floor rather than a record of the last",
|
|
"release. It is listed because server/index.js requires it, and a check that did not know it",
|
|
"ships would report the module's own manifest as missing from the bundle."
|
|
],
|
|
"server": [
|
|
"boot.js",
|
|
"core.js",
|
|
"db",
|
|
"index.js",
|
|
"model",
|
|
"package.json",
|
|
"router",
|
|
"sidecarClient.js"
|
|
],
|
|
"root": [
|
|
"swagger-fragment.json",
|
|
"LICENSE.md",
|
|
"README.md"
|
|
],
|
|
"generated": [
|
|
"module.json"
|
|
]
|
|
}
|