taskexample

Documentation

Overview

Package taskexample builds the smallest Flowfile step that runs a given task.

`flow tasks <name>` and the generated task reference (docs/reference/tasks.md, via cmd/flow/internal/docsgen) both need a worked example of the same shape — a step somebody can copy that actually compiles — so it is built once, here, rather than written by hand in two places that would drift the first time a task's required inputs changed. See CLAUDE.md's "prefer deriving to duplicating."

Index

• func Build(def v1.TaskDef) (string, error)

Functions

func Build

func Build(def v1.TaskDef) (string, error)

Build is the smallest Flowfile that runs this task, built from the task's own required inputs.

Built rather than written down, so it cannot describe a task that has changed under it, and checked by compiling it rather than by eye: every caller's own mirror test runs the result through flowfile.ValidateSource, the same compiler `flow validate` is. That is the mirror-test discipline the rest of this repo applies to a rewriter's output: asserting the bytes still mean something, rather than asserting that they were produced.

Only the required inputs. An example carrying every optional input is a specification, and the reason to show one at all is that it is the shortest thing that works.