Documentation
¶
Overview ¶
Package pipeline links a definition-side workflow to an execution-side integration: the output specs of the workflow become the input to the tool.
A Pipeline is the modeled form of a handoff such as "AWS Working Backwards (aws-one-way-door) feeds AWS AI-DLC Workflows (ai-dlc)", where the six-pager, PRD, and TRD produced on the definition side become the input the execution tool consumes. Modeling the handoff as data (rather than prose) lets a viewer render the full definition-to-execution flow, and lets execution engines drive the export deterministically.
Pipeline holds no execution logic. It references a workflow by name (see pkg/workflow / pkg/workflows) and an integration by ID (see pkg/integration / pkg/integrations), and declares how spec types map across the seam.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DefinitionRef ¶
type DefinitionRef struct {
// Workflow is the workflow name in specification-workflow-spec
// (e.g., "aws-one-way-door").
Workflow string `json:"workflow" yaml:"workflow" jsonschema:"required,description=Definition workflow name"`
// Outputs lists the spec type IDs handed off downstream
// (e.g., ["narrative-6p", "prd", "trd"]).
Outputs []string `json:"outputs,omitempty" yaml:"outputs,omitempty" jsonschema:"description=Spec type IDs handed off downstream"`
}
DefinitionRef identifies the upstream workflow and the specs it hands off.
type ExecutionRef ¶
type ExecutionRef struct {
// Integration is the integration ID (e.g., "ai-dlc").
Integration string `json:"integration" yaml:"integration" jsonschema:"required,description=Execution integration ID"`
// InputPort is the ID of the integration input Port that receives the
// handoff, if a specific one applies.
InputPort string `` /* 132-byte string literal not displayed */
}
ExecutionRef identifies the downstream integration and the port that receives the handoff.
type Handoff ¶
type Handoff struct {
// SpecType is the definition-side spec type ID (e.g., "trd").
SpecType string `json:"spec_type" yaml:"spec_type" jsonschema:"required,description=Definition-side spec type ID"`
// ToArtifact is the execution-side artifact ID (or input port ID) the spec
// feeds into.
ToArtifact string `` /* 134-byte string literal not displayed */
// Transform notes any mapping or transformation applied at the seam
// (e.g., "flatten to a single requirements.md").
Transform string `json:"transform,omitempty" yaml:"transform,omitempty" jsonschema:"description=Note on any transform applied at the seam"`
}
Handoff maps one definition-side spec type onto an execution-side destination.
type Pipeline ¶
type Pipeline struct {
// ID is the canonical identifier (e.g., "aws-one-way-door-to-ai-dlc").
ID string `json:"id" yaml:"id" jsonschema:"required,description=Canonical identifier for the pipeline"`
// Name is the human-readable name.
Name string `json:"name" yaml:"name" jsonschema:"required,description=Human-readable name"`
// Description explains the pipeline and when to use it.
Description string `json:"description,omitempty" yaml:"description,omitempty" jsonschema:"description=Pipeline purpose and use case"`
// Definition is the upstream definition-side workflow.
Definition DefinitionRef `json:"definition" yaml:"definition" jsonschema:"required,description=Upstream definition workflow"`
// Execution is the downstream execution-side integration.
Execution ExecutionRef `json:"execution" yaml:"execution" jsonschema:"required,description=Downstream execution integration"`
// Handoffs map individual definition-side spec types onto execution-side
// artifacts or input ports.
Handoffs []Handoff `json:"handoffs,omitempty" yaml:"handoffs,omitempty" jsonschema:"description=Per-spec-type handoff mappings"`
// Reference is a URL to documentation describing this pipeline.
Reference string `json:"reference,omitempty" yaml:"reference,omitempty" jsonschema:"format=uri,description=Documentation URL"`
}
Pipeline connects a definition workflow to an execution integration.