Connector conformance & tiers
Every faucet connector — built-in or third-party — can be graded against the faucet connector contract and its capabilities. The grade is a conformance score (0–100) that maps to a maturity tier, so you can answer “can I bet a pipeline on this connector?” at a glance, and connector authors know exactly what to improve to level up.
Compute it any time with faucet conformance.
Tiers
| Tier | Badge | Score | Meaning |
|---|---|---|---|
| Stable | 🟢 | ≥ 70 | Production-ready: registered, a complete config schema, documented. |
| Experimental | 🟡 | 45–69 | Works, but missing some of the contract (e.g. no config schema yet). |
| Beta | 🟠 | 20–44 | Early — only partial contract coverage. |
| Draft | ⚪ | < 20 | Scaffolded / incomplete. |
The tier is advisory — a legitimately-early connector can still ship. It is
not a merge blocker unless you opt in with faucet conformance --min-tier <tier>
in CI.
How the score is computed
The score is deterministic and instantiation-free — it reads authoritative signals the CLI already tracks (the registry index and each connector’s trait-reported capabilities), so it can never drift from the code.
| Dimension | Points | What it checks |
|---|---|---|
| Registered & verified | 40 | a verified entry in cli/connectors/registry.json |
| Config schema | 30 | config_schema() returns a real, non-empty object schema |
| Documented | 10 | a one-line description in the connector catalog |
| Exactly-once delivery | 10 | source: deterministic replay from a bookmark · sink: atomic-watermark idempotent writes |
| Dataset discovery (source) | 10 | faucet discover introspects the catalog |
| Upsert / mirror (sink) | 6 | write_mode: upsert | delete |
| Schema evolution (sink) | 4 | evolves the destination schema on drift |
The core contract — a verified registry entry (40) + a real config schema
(30) = 70 — is the Stable gate. Everything else is a bonus that lifts the score
and adds a capability badge without gating the tier. So every conforming built-in
lands at Stable, while an incomplete third-party connector (no verified entry /
no schema) drops to Experimental / Beta.
Where the tier surfaces
faucet conformance— the full per-connector scorecard (dimension pass/fail + points, total, tier, capability badges).--jsonfor CI.faucet list— a tier badge next to every compiled-in source and sink.cli/connectors/registry.json— a per-connectortierfield, validated in CI against the computed score so the published catalog stays honest.faucet new connector— the scaffold’s starting tier (⚪ Draft) plus the checklist to reach 🟢 Stable.
A badge for your crate README
faucet conformance <name> prints a shields.io badge URL you can drop into a
third-party faucet-source-* / faucet-sink-* crate README:
Third-party connectors
Out-of-repo connectors are scored from their trait-reported capabilities
only — the repo-scan dimensions (verified registry entry, catalog docs) don’t
apply, so a community connector is typically graded on its config schema and the
capabilities it advertises. Publish a PR adding a verified registry entry to
have it scored like a built-in.
Related
faucet conformance— the command- Connector catalog — per-connector capability matrix
- API stability policy
- Authoring connectors