Generated Artifact Registry And Quality Gate Integration
Purpose
Use this page when adding, checking, or repairing generated JSON, generated docs, bake manifests, UI manifests, protocol registries, or aggregate catalog outputs that must stay synchronized with source content.
Steps
Add a descriptor to the generated artifact registry, including inputs, output path, renderer, check command, and write command. Wire it into the relevant xtask quality gate profile. Add tests that fail when the generated output drifts. Document any artifact that should be included in pack export or Forgejo wiki export.
Expected Outputs
Generated outputs should carry stable schema/version data where appropriate, deterministic ordering, and enough metadata for drift reports to name the source inputs. Quality gates should report whether the artifact is current or needs regeneration.
Common Mistakes
Do not create a generated file without a registry entry. Do not rely on manual regeneration notes only in a PR. Do not change renderer ordering without accepting that every downstream golden output may update.
Recovery Paths
Run the artifact write command, inspect the diff, rerun the targeted check, then rerun the quality gate profile. If a generated artifact feeds pack export, rerun the pack gate before shipping.