reci.validation.rules.flow

Data-flow validation rules (FLOW001–FLOW007).

Functions

check_ambiguous_wiring(graph, config)	An input name matches multiple upstream outputs, in a job or across jobs.
check_boolean_coercion(graph, config)	A string output is wired to a likely-boolean input.
check_matrix_output(graph, config)	A job output consumed by another job comes from a matrix or conditional job.
check_output_references(graph, config)	A steps.*.outputs.* or needs.*.outputs.* reference that resolves to nothing.
check_unsourced_required_inputs(graph, config)	Required input has no source at any level.
check_unused_outputs(graph, config)	An output is declared but never consumed downstream.

reci.validation.rules.flow.check_ambiguous_wiring(graph, config)

An input name matches multiple upstream outputs, in a job or across jobs.

Within a job the nearest preceding step wins. Across jobs there is no nearer: the first producing job in recipe order is used.

Return type:

Iterable[Finding]

reci.validation.rules.flow.check_boolean_coercion(graph, config)

A string output is wired to a likely-boolean input.

Return type:

Iterable[Finding]

reci.validation.rules.flow.check_matrix_output(graph, config)

A job output consumed by another job comes from a matrix or conditional job.

A matrix job has one output value for all its legs: whichever leg finishes last wins. A job with an if: that is false is skipped, and so is every job that needs it (unless it uses always() or similar).

Return type:

Iterable[Finding]

reci.validation.rules.flow.check_output_references(graph, config)

A steps.*.outputs.* or needs.*.outputs.* reference that resolves to nothing.

• steps.<id>.outputs.<name> naming a step that does not run before the reader, or an output the step’s action does not declare (- and _ are different characters to GitHub).

• needs.<job>.outputs.<name> naming a job that is not among the job’s needs (explicit or inferred from data flow), or an output that job neither declares in outputs: nor has forwarded by the compiler.

Return type:

Iterable[Finding]

reci.validation.rules.flow.check_unsourced_required_inputs(graph, config)

Required input has no source at any level.

Return type:

Iterable[Finding]

reci.validation.rules.flow.check_unused_outputs(graph, config)

An output is declared but never consumed downstream.

Consumed means: matched by an input of a later step (by name, honouring bind:), or read explicitly as steps.<id>.outputs.<name> (dot or bracket syntax; ids and names compared as GitHub does: ignoring case, but - and _ differ) inside a ${{ }} of a later step of the same job: its with:, env:, run:, if:, name: or other keys, or in a job outputs: entry (a job’s other fields cannot read steps). needs. references are not counted: only the compiler’s own forwarding and the job outputs: the recipe declares make them resolve.

Return type:

Iterable[Finding]