rules/workflows/generate_build.js

Developer reference: this page includes exported implementation details. BUILD authors should prefer the User API reference.

GENERATE_BUILD

const GENERATE_BUILD

Undocumented.

registerBuildGenerator()

registerBuildGenerator({ namespace, kind, generate })

Register a rules group's generate-build product for config-gated dispatch. namespace is the rules group's configuration namespace (e.g. "odin") — its buildGenerate bool config field decides whether kind's "generate-build" product runs on imp goal generate-build. Defaults to off; a rules group opts in via defineConfigSchema(namespace, { buildGenerate: field.bool({ default: false }) }) plus a workspace config export setting it to true. "generate-build" product should run. label-based rules should prefer this form.

ParameterTypeDescription
optsobject
opts.namespacestringConfiguration namespace whose buildGenerate field gates this generator.
[opts.kind]Functionstring
[opts.generate]FunctionDirect async generator callback. New

Returns: void