Share repo tools from one public repo (RIG-4351)
Problem / Intent
Section titled “Problem / Intent”Compass and one private consumer repo each keep their own copy of the same repo
tools, and the copies drift. A fix lands in one copy and not the other. Example:
the private consumer’s design-ledger gate exempted Trunk merge-queue branches
(trunk-merge/) long before compass’s copy did. Compass only found the gap when
its CI began running the touch-coupling leg and queued PRs started failing.
Intent: move every tool both repos run into one new public repo, and have each consumer pin it, so each tool has one copy. This record folds in RIG-4184 (“share the design-ledger tools from one source”). The ledger tools are its first slice.
Inventory
Section titled “Inventory”Measured on 2026-10-04 with git diff --no-index --stat between the compass
copy and the private consumer’s copy (changes are compass relative to the
private copy). “Private copy” says only whether a copy exists. This public
record names no path in the private repo.
| Tool | Compass path | Private copy | Drift | Verdict |
|---|---|---|---|---|
| Design-ledger gate | tools/design-ledger-gate/ |
Yes | Large: 6 files, +1,143 / −6,735. The private copy finds per-surface ledgers by glob, reports malformed rows, has citation, errata, and record-link legs, exempts trunk-merge/, and parses with micromark. Compass has one ledger and a fixed bucket list. |
Move (T4) |
| DL reconcile | tools/dl-reconcile/ |
Yes | Yes: 6 files, +1,088 / −501. Compass reads one ledger, cross-counts raw rows, refuses an empty frontier, and has --check. The private copy reads several ledgers and reports stale and duplicate claims. |
Move (T5) |
| DL claim | tools/dl-claim/ |
No | None to measure. Compass-only client; the request type hard-codes repo: "compass". |
Move (T5) |
| SEA reference gate | tools/sea-ref-gate/ |
Yes | Yes: 8 files, +334 / −611. The private copy splits the core into its own module. | Move as ref-gate (T3) |
| Private-name reference gate | A sibling of the SEA gate under tools/ |
No | None to measure. Same four exported functions as the SEA gate (isCarveOut, lineHasToken, findViolations, runOnce). |
Becomes a ref-gate config (T3) |
| Renovate preflight | tools/renovate-preflight/ |
Yes | Small: 6 files, +47 / −43 (comments, task and package config). | Move (T6) |
| Bun moon task template | .moon/tasks/tag-bun.yml |
Yes | Comments only. No task differs. | Stay local |
| Root checks | lint, format, markdownlint tasks in the root moon.yml |
Different tool | Not a copy. The private consumer runs a separate tool that runs its checks outside the moon cache and gates baked linter versions. | Stay local |
| Agent extensions | None | Yes | None to measure. Personal agent config, not repo tooling. | Stay private |
| Renovate config | tools/renovate/config.json5 |
Yes | Different files that share ideas (git-refs cooldown, catalog handling). | Later record |
| Renovate upgrade scripts | tools/renovate/refresh-go-overlay[.core].ts, refresh-devenv-nixpkgs[.core].ts, refresh-toolchain-hashes.ts |
Yes, same names | Not measured. Each bot config’s allowedCommands regex names these paths, so moving them changes that config too. |
Later record |
Approach
Section titled “Approach”One public repo, one package per tool
Section titled “One public repo, one package per tool”Use the public repo RigelBuild/meissa (see Decisions). The tooling lane
creates it and builds its Nix side: a pinned nixpkgs, the shared rumdl and
biome, and a daily relock. This record adds the TS tools to it. They form a bun
workspace with one package per tool
under packages/<tool>/, published as @rigelbuild/<tool> with a bin of the
same name. Each consumer pins exact versions and deletes its own copy in
the same PR. There is no shim and no re-export.
The port base is the compass copy. It is already public, so starting from it moves nothing private. Features only the private copy has (per-surface ledgers, the citation, errata, and record-link legs, malformed-row reporting) are written again as new public code on top of it (OQ3: yes).
Config, not literals
Section titled “Config, not literals”The two repos differ in real ways. Compass has one ledger and a fixed bucket
list. The private consumer has several per-surface ledgers. Each repo claims DL
IDs from its own counter partition. So no consumer value is a literal in shared
code. Each consumer keeps one config file, docs/designs/ledger.config.json,
which the gate, claim, and reconcile tools all read. The reference gate reads
its own config file.
The CLIs keep their environment inputs (REPO, PR_NUMBER, GH_TOKEN,
DL_CLAIM_TOKEN, RENOVATE_TOKEN). Every tool also reads GATE_ROOT, default
the git toplevel, as the consumer root. A tool under node_modules cannot find
the ledger relative to its own file, as dl-reconcile does today
(resolve(import.meta.dir, …)). The counter URL comes only from
counter.url; no env var overrides it.
Exit codes are normalized to 0 pass, 1 violations, 2 usage or internal error.
This is a change, not a carry-over: dl-claim and dl-reconcile exit 1 for
every error today. CI only checks for non-zero, so no workflow changes.
CI wiring changes more than the command. dl-reconcile.yml and the Renovate
preflight step in renovate.yml run the tool from the checkout with no
bun install, and both jobs hold a secret. A package bin needs an install
first. Per OQ4, those jobs run the full bun install --frozen-lockfile, so
every install is checked against bun.lock.
Pinning (OQ1: npm)
Section titled “Pinning (OQ1: npm)”| Option | How a consumer pins | For | Against |
|---|---|---|---|
| npm package (chosen for TS tools) | Exact version in the bun catalog; bun.lock keeps the integrity hash |
Both repos already take tools as bun dependencies. Compass’s Renovate catalog manager already reads npm versions. One package per tool. | Needs a publish lane in the shared repo and a one-time bootstrap publish per package |
| bun git dependency | github:RigelBuild/meissa#<sha> in the root package.json |
No registry and no publish lane | One package for the whole repo (bun installs a git repo root, not a subdirectory). Compass’s catalog manager reads only npm versions. |
| Rev-pin JSON | A {repo, ref, rev} file plus a fetch step before each run. The private consumer already pins compass this way. |
Precedent exists, and compass’s Renovate config already bumps git revs with a regex manager | Each consumer writes its own fetch step. The tools’ own npm dependencies need a separate install. No typed imports. Local runs need the fetch too. |
| Nix flake input | Flake input, locked by the consumer’s lock file (devenv.lock in compass) |
Content-addressed and nix-native | Each bun tool would need a nix package build, and moon and tsc cannot typecheck against a store path. |
TS tools ship as npm packages, so a tool bump is an ordinary catalog PR with release notes. Per OQ5, first-party pins skip the release-age cooldown in every toolchain.
Publishing uses npm trusted publishing (OIDC from the shared repo’s main
release workflow), so no long-lived publish token exists. The @rigelbuild
npm scope already exists (compass resolves @rigelbuild/solid-virtual from
npm). npm can set a trusted publisher only on a package that already exists,
so each new package needs one bootstrap publish and one trusted-publisher entry.
These steps have no IaC path, so they go to Matt as one human-action issue.
Nix tooling
Section titled “Nix tooling”Matt’s OQ1 ruling first added Nix: meissa would also export the Nix code both repos carry. T10 measured it. Only one file is shared, the vendored bun, node and moon builder, with 6 lines of drift. Matt then ruled (RIG-4548) to reconcile that file by hand in each repo instead of shipping it from meissa. So this record moves no Nix code. Meissa’s own Nix exports (rumdl, biome, the rumdl base policy) are the tooling lane’s work.
What may move (the public boundary)
Section titled “What may move (the public boundary)”A tool qualifies only if all three conditions hold:
- It runs in compass today, or it is a generic check that any public repo could run unchanged.
- It holds no consumer literal: no private repo name, path, surface name, counter partition, hostname, or record citation. Those come from consumer config.
- Its tests use synthetic fixtures only.
Enforcement:
- The shared repo runs
ref-gateon itself as a required check. It fails closed on the private repo’s name and on retired SEA issue ids, the same as compass. The name appears only in the gate’s own config file, which is carved out, as compass carves out its gate source today. - Every port PR starts from public code. A private-only feature is written again and reviewed against the three conditions. It is never copied file to file.
- Matt is CODEOWNER and approves every PR, as in compass.
Drift prevention after migration
Section titled “Drift prevention after migration”No copy is left to drift. A consumer cannot patch a tool locally without adding a copy back, and the Global Constraints forbid that. Renovate bumps both pins, so skew between the consumers is a version number, not a fork. Because first-party pins skip the cooldown (OQ5), the skew lasts from release to the next Renovate run plus Matt’s review of each bump PR. A fix lands as a shared-repo PR and reaches each consumer by pin bump.
Alternatives considered
Section titled “Alternatives considered”- Keep the tools in compass and have the private consumer pin compass: rejected
by the ask. It ties the consumer to compass’s
mainand mixes product releases with tool releases. - Keep vendored copies and add a CI check that they match the pin: rejected. It keeps two copies to edit, and the check only reports drift after it happens.
- Git submodule: rejected. jj, the house VCS, does not manage submodules.
Global Constraints
Section titled “Global Constraints”- The shared repo is public and follows the boundary in “What may move”.
- Licence:
MIT OR Apache-2.0(OQ6). This relicenses tools that are AGPL-3.0-only in compass, so T2 first checks that no ported file has an outside contribution. A file that has one stays out until its author agrees. - Runtime and checks: bun, TypeScript
strictplusnoUncheckedIndexedAccess, biome,bun test, rumdl for markdown. - Each tool is the package
@rigelbuild/<tool>underpackages/<tool>/, with bin<tool>pointing at./index.ts(shebang#!/usr/bin/env bun). - CLIs read
GATE_ROOT(default git toplevel) and exit 0 / 1 / 2 as defined in “Config, not literals”. - Consumers pin an exact npm version, never a range. Bumps arrive only by Renovate PR.
- First-party pins skip the release-age cooldown wherever one applies (OQ5):
@rigelbuild/*npm packages inbunfig.toml(exact names, one entry each) and in Renovate, andRigelBuild/*git-refs pins in Renovate. Go modules and nix inputs have no package-manager cooldown, and compass has no first-party Go dependency today. - A consumer’s switch PR deletes its local copy in the same PR. No vendored copy, wrapper, or re-export stays behind.
- No consumer literal in shared code, tests, comments, or docs.
Order: T1 (meissa exists), T2, T3, then T4 and T6 in parallel, then T5, then
T7, T8, T9. T10 is done.
T3 comes first among the tools because it guards every later meissa PR.
T5 follows T4 because it imports LedgerConfig from the T4 package. RIG-4184’s
scope is T4, T5, and the ledger part of T7 and T8.
T1 — Meissa exists
Section titled “T1 — Meissa exists”Not built here. The tooling lane creates meissa through the org’s GitHub IaC,
with a seeded main, a ruleset, and a place in the Trunk queue, then adds its
Nix exports and daily relock. This record’s T2 starts once that lands.
Interfaces: consumes meissa’s main, ruleset, and CI.
T2 — Bun workspace and release lane
Section titled “T2 — Bun workspace and release lane”Lands in: meissa, plus one org GitHub IaC change after its CI first runs
(meissa’s ruleset gains the required checks). A bun workspace over
packages/*, moon, a licence file under each package (after the
outside-contribution check), a GitHub Actions CI job that runs typecheck,
lint, and test per package, and
the release lane: release-please per package, then
npm publish --provenance through trusted publishing, after the bootstrap
publish of each package. It reuses the rumdl and biome meissa already exports.
The tooling lane owns meissa’s devenv, flake, and relock rules, and they
export only rumdl and biome. So T2 adds bun, node, and moon to meissa’s dev
shell and CI, from nixpkgs at meissa’s pin, as an addition the tooling lane
reviews. T2 adds only the npm and release-please Renovate rules. Any secret
the release lane needs on meissa is a separate org GitHub IaC change in T2;
the tooling lane provisions only the Renovate App credentials.
Interfaces: each packages/<tool>/package.json has
"name": "@rigelbuild/<tool>" and "bin": { "<tool>": "./index.ts" }.
T3 — ref-gate
Section titled “T3 — ref-gate”Lands in: the shared repo. Merge compass’s sea-ref-gate and private-name gate
into one config-driven gate. Turn it on as the shared repo’s own required check
in the same PR.
Interfaces:
export interface RefGateConfig { prefilter: { ere: string; ignoreCase: boolean }; // POSIX ERE handed to git grep patterns: readonly { source: string; flags: string }[]; // JS RegExp, applied per hit ignore: readonly string[]; // compound names stripped before matching, e.g. a gate's own name carveOutPaths: readonly string[]; carveOutPrefixes: readonly string[]; allowlist: Readonly<Record<string, string>>; // path -> reason remediationDoc?: string;}export function loadRefGateConfig(path: string): RefGateConfig; // throws on unknown keysexport function findViolations(config: RefGateConfig, grepHits: readonly string[]): Reference[];export async function runOnce(deps: Deps, config: RefGateConfig): Promise<number>;The coarse git-grep search is its own POSIX ERE, not derived from the JS
patterns. A JS-only construct such as \b in a git-grep ERE can match nothing,
and the gate then passes when it should fail.
CLI: ref-gate --config <path>.
T4 — design-ledger-gate
Section titled “T4 — design-ledger-gate”Lands in: the shared repo. Port compass’s gate. Add a list of ledgers (each with its own surface), malformed-row reporting, and the three extra legs behind config (OQ3: yes). Tests: compass’s tests plus synthetic multi-ledger fixtures. Each extra leg gets a fixture that must fail (a malformed row, a stale citation, a missing errata target, a broken record link) and one that must pass.
Interfaces:
export interface LedgerEntry { path: string; // e.g. "docs/designs/DECISIONS.md" surface: string; // counter surface for IDs in this ledger governedRoots: readonly string[]; // record dirs this ledger governs}export interface LedgerConfig { ledgers: readonly LedgerEntry[]; // compass: one entry historicalChain?: readonly string[]; // record paths that must be Historical exemptBranchPrefixes?: readonly string[]; // default ["renovate/", "trunk-merge/"] legs?: { citations?: boolean; errata?: boolean; recordLinks?: boolean }; // each default false counter: { url: string; partition: string };}export function loadLedgerConfig(path: string): LedgerConfig; // throws on unknown keysexport async function runOnce(deps: Deps, config: LedgerConfig): Promise<number>;CLI: design-ledger-gate --config docs/designs/ledger.config.json.
T5 — dl-claim and dl-reconcile
Section titled “T5 — dl-claim and dl-reconcile”Lands in: the shared repo. Both depend on @rigelbuild/design-ledger-gate for
LedgerConfig and loadLedgerConfig, so the loader has one copy. Reconcile
keeps compass’s guards (raw-row cross-count, empty-frontier refusal, --check)
and adds the stale and duplicate claim report. Messages that name the counter
take its URL from config.
Interfaces:
// dl-claimexport interface ClaimRequest { repo: string; surface: string; ref: string; lane: string; count: number }export function buildClaimBody(config: LedgerConfig, args: ClaimArgs): ClaimRequest;// dl-reconcileexport interface LandedDecision { id: string; surface: string; ref: string }export interface ReconcileRequest { repo: string; landed: LandedDecision[] }export function assertReconcilableLedgers( config: LedgerConfig, ledgers: ReadonlyMap<string, string>, // ledger path -> text): ReconcileRequest;CLIs: dl-claim --config <path> --ref <RIG-n|none> --lane <branch> [--count 1..10] [--surface <s>]
and dl-reconcile --config <path> [--check], both reading DL_CLAIM_TOKEN.
--surface is required when the config lists more than one ledger. repo is
always counter.partition. Consumes the T4 release.
T6 — renovate-preflight
Section titled “T6 — renovate-preflight”Lands in: the shared repo. Move compass’s copy unchanged except package metadata.
Interfaces: CLI renovate-preflight, env REPO and RENOVATE_TOKEN, exit
codes as today; classify(probe: ProbeResult): PreflightResult stays exported.
T7 — Compass cutover
Section titled “T7 — Compass cutover”Lands in: compass. Add the five packages at exact versions. Add
docs/designs/ledger.config.json: one ledger (docs/designs/DECISIONS.md,
surface designs, the seven current buckets ui, agent, server, meta,
infra, observability, repo), an empty historical chain, renovate/ and
trunk-merge/ exempt, all legs off, partition compass, url
https://dl.rigel.build.
Add two code-free moon projects:
tools/design-ledger/:checkandcitasks call thedesign-ledger-gateanddl-reconcile --checkbins.tools/ci-matrix/index.tsinjectsALWAYS_RUN_ON_PRby moon project id, and it injects nothing, with no error, when the project is missing. So keep the iddesign-ledger-gate, or updateALWAYS_RUN_ON_PRand its test in the same PR.tools/ref-gates/:moon.ymlplus the configssea.jsonandprivate-name.json. Each config carves outtools/ref-gates/. The private-name token lives only in that carved-out config, as it lives today only in the carved-out source of the current gate. Itsignorelist keeps the current gate’s directory name, because existing records cite that path.
Point the moon tasks, .github/workflows/dl-reconcile.yml, the Renovate
preflight step, .moon/workspace.yml, docs/designs/CONTRIBUTING.md §7, and
docs/concepts/self-host-and-managed.md (which names the old ref-gate task) at
the new bins and projects. The two secret-holding jobs gain a
bun install --frozen-lockfile step (OQ4). Exempt first-party pins from the
cooldown (OQ5). In bunfig.toml, add each new @rigelbuild/* package by
exact name to minimumReleaseAgeExcludes. In Renovate, add those names to the
catalog soak-exemption rule, which config.test.ts requires to match the
catalog part of the bunfig list. Add a rule exempting the
@rigelbuild/solid-* pins in apps/ui/package.json, which still soak today.
Confirm every RigelBuild/* git-refs rule already sets
minimumReleaseAge: null. Delete
tools/design-ledger-gate/, tools/dl-claim/, tools/dl-reconcile/,
tools/sea-ref-gate/, the private-name gate’s directory, and
tools/renovate-preflight/.
Acceptance:
- A seeded corpus, as its own git repo. For each gate leg the corpus holds one
seeded fault. The PR body lists, per fault, the expected
file:lineand the expected exit code (1). Both the old and new tools must report exactly thatfile:lineand exit 1. Only the old ledger gate readsGATE_ROOT. Run the old ref gates with cwd set to the corpus, and compare old reconcile through its exportedassertReconcilableLedgeron the corpus ledger. - The same corpus with the faults removed: both tools exit 0 and report no violations.
- Exempt prefixes apply only to the ledger gate’s touch-coupling leg, which
needs PR context. Seed a record touched with no ledger edit and no
Ledger-impact:line. Drive both ledger gates throughrunOncewith that injected changed set and aheadBranch. A normal branch exits 1 on both.renovate/andtrunk-merge/exit 0 on both. The tool name in output is the stated intended change. - On a docs-only PR, the ci-matrix output still contains the ledger gate target.
Record each result in the PR body.
Interfaces: consumes the T3–T6 releases; produces the config files above.
T8 — Private consumer cutover
Section titled “T8 — Private consumer cutover”Lands in: the private consumer. The same shape as T7: its own
ledger.config.json (one entry per surface ledger, all legs on, its own
partition), its own reference-gate config, CI pointed at the bins, and its
local copies deleted. The same seeded-corpus acceptance as T7.
Interfaces: consumes the T3–T6 releases.
T9 — Compass turns on the extra ledger legs
Section titled “T9 — Compass turns on the extra ledger legs”Lands in: compass. Run the citation, errata, and record-link legs over the corpus, fix every finding, and turn the legs on in the same PR.
Interfaces: consumes T4; edits legs in docs/designs/ledger.config.json.
T10 — Shared Nix tooling inventory
Section titled “T10 — Shared Nix tooling inventory”Its record is docs/designs/repo/compass-shared-nix-tooling/design.md. It
measured the Nix both repos carry. Matt ruled to reconcile the one shared
builder by hand (RIG-4548), so no Nix moves to meissa. The task is done when
that record merges.
Out of scope
Section titled “Out of scope”Later records: a shared Renovate preset and moving the Renovate upgrade
scripts. The
moon task template and the root checks stay local (see Inventory). Wiring the
touch-coupling leg into compass CI is separate work. The DL counter service
(dl.rigel.build) does not move.
- T1 — Meissa exists (tooling lane).
- T2 — Add the bun workspace and release lane to meissa.
- T3 — Ship
ref-gateand make it the shared repo’s required check. - T4 — Port
design-ledger-gateonto a list of ledgers. - T5 — Port
dl-claimanddl-reconcileontoLedgerConfig. - T6 — Move
renovate-preflight. - T7 — Cut compass over and delete its six local tools.
- T8 — Cut the private consumer over and delete its local copies.
- T9 — Turn on compass’s extra ledger legs.
- T10 — Write the shared Nix tooling inventory record.
Decisions (Matt, 2026-10-04 RIG-4440; repo name and Nix 2026-10-05)
Section titled “Decisions (Matt, 2026-10-04 RIG-4440; repo name and Nix 2026-10-05)”- OQ1 — pin mechanism: npm packages for the TS tools. Matt added Nix; T10 measured it and RIG-4548 ruled reconcile by hand, so no Nix moves.
- OQ2 — names: npm scope
@rigelbuild/<tool>. The repo isRigelBuild/meissa, the public shared infrastructure repo (RIG-4469). - OQ3 — publish the private-only ledger-gate features: yes, written again as public code with synthetic fixtures.
- OQ4 — install in secret-holding jobs: a full
bun install --frozen-lockfile. - OQ5 — cooldown: every first-party pin skips the release-age cooldown, in every toolchain (TS, Go, Nix).
- OQ6 — licence: relicense to
MIT OR Apache-2.0.