tektontypes

package
v1.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 15, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

Package tektontypes defines minimal Go types matching the tekton.dev/v1 schema for Task, TaskRun, Pipeline, and PipelineRun. JSON tags align with upstream so `kubectl apply -f` and `tkn-act` parse the same YAML identically.

Scope is intentionally narrow — only fields that the v1 implementation actually reads. Fields we don't support (sidecars, stepActions, retries, resolvers) are not parsed.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ConfigMapSource added in v1.2.0 

type ConfigMapSource struct {
	Name     string      `json:"name"`
	Items    []KeyToPath `json:"items,omitempty"`
	Optional *bool       `json:"optional,omitempty"`
}

type ContainerPort added in v1.6.0 

type ContainerPort struct {
	Name          string `json:"name,omitempty"`
	ContainerPort int    `json:"containerPort"`
	Protocol      string `json:"protocol,omitempty"`
}

ContainerPort is a fidelity-only stub for upstream's corev1.ContainerPort. tkn-act records the bytes and forwards them to the cluster backend; no semantic effect on docker.

type EmptyDirSource added in v1.2.0 

type EmptyDirSource struct {
	// Medium: "" (disk-backed tmpdir) or "Memory" (tmpfs on Linux).
	Medium string `json:"medium,omitempty"`
}

type EnvVar 

type EnvVar struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type HostPathSource added in v1.2.0 

type HostPathSource struct {
	Path string `json:"path"`
	Type string `json:"type,omitempty"` // diagnostic only
}

type KeyToPath added in v1.2.0 

type KeyToPath struct {
	Key  string `json:"key"`
	Path string `json:"path"`
}

type Matrix added in v1.6.0 

type Matrix struct {
	Params  []MatrixParam   `json:"params,omitempty"`
	Include []MatrixInclude `json:"include,omitempty"`
}

Matrix declares a Cartesian-product fan-out of one PipelineTask across one or more named string-list params. Optional include rows add named combinations on top of the cross-product. Mirrors Tekton v1 PipelineTask.matrix for the subset tkn-act reads.

type MatrixInclude added in v1.6.0 

type MatrixInclude struct {
	Name   string  `json:"name,omitempty"`
	Params []Param `json:"params,omitempty"`
}

MatrixInclude is one extra named row. Its params introduce param names not present in matrix.params. tkn-act rejects include rows whose params overlap a cross-product param name (would diverge from upstream Tekton's fold semantics on the cluster backend); see docs/superpowers/specs/2026-05-04-pipeline-matrix-design.md.

type MatrixInfo added in v1.6.0 

type MatrixInfo struct {
	Parent string
	Index  int
	Of     int
	Params map[string]string
	// IncludeName is the include row's declared name when the row
	// originated from matrix.include and that row had a name. Empty
	// for cross-product rows and for unnamed include rows.
	IncludeName string
}

MatrixInfo is the per-expansion identity: which parent PipelineTask the row came from, where it sits in the row order, and what params the row contributed. Carried through the engine (TaskOutcome.Matrix), the cluster backend (TaskOutcomeOnCluster.Matrix), and the reporter (Event.Matrix). Declared here (not in internal/engine) so the engine, backend, and reporter packages can share it without an import cycle.

type MatrixParam added in v1.6.0 

type MatrixParam struct {
	Name  string   `json:"name"`
	Value []string `json:"value"`
}

MatrixParam is a name + value list. Tekton requires `value` to be a list of strings here (no scalars, no objects); the validator enforces it.

type MatrixRow added in v1.6.0 

type MatrixRow struct {
	Params      map[string]string
	IncludeName string
}

MatrixRow is the public shape of one materialized matrix row, used by both the engine's expandMatrix pass (internally) and the cluster backend's TaskRun-to-expansion matcher (which reads it from MaterializeMatrixRows). Lives in tektontypes so the cluster package can build the same row order the engine would, without an engine→backend import cycle.

func MaterializeMatrixRows added in v1.6.0 

func MaterializeMatrixRows(pt PipelineTask) []MatrixRow

MaterializeMatrixRows builds the same cross-product + include rows the engine's expandMatrix produces, in the same order. Returns nil for non-matrix tasks. Errors (cardinality cap, empty value list) cause MaterializeMatrixRows to return nil — the validator rejects those cases at validate time so they cannot reach the cluster backend in practice.

type Metadata 

type Metadata struct {
	Name        string            `json:"name"`
	Namespace   string            `json:"namespace,omitempty"`
	Labels      map[string]string `json:"labels,omitempty"`
	Annotations map[string]string `json:"annotations,omitempty"`
}

type Object 

type Object struct {
	APIVersion string   `json:"apiVersion"`
	Kind       string   `json:"kind"`
	Metadata   Metadata `json:"metadata"`
}

Object is the common envelope shared by Task/Pipeline/TaskRun/PipelineRun.

type Param 

type Param struct {
	Name  string     `json:"name"`
	Value ParamValue `json:"value"`
}

type ParamSpec 

type ParamSpec struct {
	Name        string      `json:"name"`
	Type        ParamType   `json:"type,omitempty"` // default string
	Description string      `json:"description,omitempty"`
	Default     *ParamValue `json:"default,omitempty"`
}

type ParamType 

type ParamType string
const (
	ParamTypeString ParamType = "string"
	ParamTypeArray  ParamType = "array"
	ParamTypeObject ParamType = "object"
)

type ParamValue 

type ParamValue struct {
	Type      ParamType
	StringVal string
	ArrayVal  []string
	ObjectVal map[string]string
}

ParamValue can be a string, []string, or map[string]string. Custom JSON unmarshaler picks the right shape from the input.

func (ParamValue) MarshalJSON 

func (v ParamValue) MarshalJSON() ([]byte, error)

func (*ParamValue) UnmarshalJSON 

func (v *ParamValue) UnmarshalJSON(data []byte) error

type Pipeline 

type Pipeline struct {
	Object `json:",inline"`
	Spec   PipelineSpec `json:"spec"`
}

type PipelineRef 

type PipelineRef struct {
	Name string `json:"name,omitempty"`
	// Resolver names a Tekton resolver (git | hub | http | bundles |
	// cluster | custom-name-in-remote-mode). When non-empty, Name is
	// ignored — the resolver is authoritative.
	Resolver string `json:"resolver,omitempty"`
	// ResolverParams are the resolver-specific name=value pairs nested
	// inside the `resolver:` block of a pipelineRef.
	ResolverParams []ResolverParam `json:"params,omitempty"`
}

type PipelineResultSpec 

type PipelineResultSpec struct {
	Name        string     `json:"name"`
	Description string     `json:"description,omitempty"`
	Value       ParamValue `json:"value"`
}

type PipelineRun 

type PipelineRun struct {
	Object `json:",inline"`
	Spec   PipelineRunSpec `json:"spec"`
}

type PipelineRunSpec 

type PipelineRunSpec struct {
	PipelineRef  *PipelineRef           `json:"pipelineRef,omitempty"`
	PipelineSpec *PipelineSpec          `json:"pipelineSpec,omitempty"`
	Params       []Param                `json:"params,omitempty"`
	Workspaces   []PipelineRunWSBinding `json:"workspaces,omitempty"`
}

type PipelineRunWSBinding 

type PipelineRunWSBinding struct {
	Name     string    `json:"name"`
	EmptyDir *struct{} `json:"emptyDir,omitempty"`
	HostPath string    `json:"-"` // tkn-act extension; populated from CLI -w flag
}

type PipelineSpec 

type PipelineSpec struct {
	DisplayName string                  `json:"displayName,omitempty"`
	Description string                  `json:"description,omitempty"`
	Params      []ParamSpec             `json:"params,omitempty"`
	Workspaces  []PipelineWorkspaceDecl `json:"workspaces,omitempty"`
	Tasks       []PipelineTask          `json:"tasks"`
	Finally     []PipelineTask          `json:"finally,omitempty"`
	Results     []PipelineResultSpec    `json:"results,omitempty"`
	Timeouts    *Timeouts               `json:"timeouts,omitempty"`
}

type PipelineTask 

type PipelineTask struct {
	Name        string             `json:"name"`
	DisplayName string             `json:"displayName,omitempty"`
	TaskRef     *TaskRef           `json:"taskRef,omitempty"`
	TaskSpec    *TaskSpec          `json:"taskSpec,omitempty"` // inline task
	Params      []Param            `json:"params,omitempty"`
	Workspaces  []WorkspaceBinding `json:"workspaces,omitempty"`
	RunAfter    []string           `json:"runAfter,omitempty"`
	When        []WhenExpression   `json:"when,omitempty"`
	// Retries is the number of additional attempts after the first failure.
	// 0 (or unset) means run once.
	Retries int `json:"retries,omitempty"`
	// Matrix declares a Cartesian-product fan-out of this PipelineTask
	// across one or more named string-list params, with optional named
	// `include` rows. Mirrors Tekton v1 PipelineTask.matrix.
	Matrix *Matrix `json:"matrix,omitempty"`

	// MatrixInfo is the per-expansion identity assigned by the engine's
	// expandMatrix pass; not part of the YAML schema. The engine reads
	// it when emitting task-start / task-end / task-skip events to
	// populate reporter.Event.Matrix. Never serialized.
	MatrixInfo *MatrixInfo `json:"-"`
}

type PipelineWorkspaceDecl 

type PipelineWorkspaceDecl struct {
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
	Optional    bool   `json:"optional,omitempty"`
}

type ResolverParam added in v1.6.0 

type ResolverParam struct {
	Name  string     `json:"name"`
	Value ParamValue `json:"value"`
}

ResolverParam is the substitution-eligible shape resolvers consume. Mirrors Tekton's tekton.dev/v1 resolver param: name + value.

type ResourceList 

type ResourceList struct {
	CPU    string `json:"cpu,omitempty"`
	Memory string `json:"memory,omitempty"`
}

type ResultSpec 

type ResultSpec struct {
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
	Type        string `json:"type,omitempty"` // string|array|object; default string
}

type SecretSource added in v1.2.0 

type SecretSource struct {
	SecretName string      `json:"secretName"`
	Items      []KeyToPath `json:"items,omitempty"`
	Optional   *bool       `json:"optional,omitempty"`
}

type Sidecar added in v1.6.0 

type Sidecar struct {
	Name            string           `json:"name"`
	Image           string           `json:"image"`
	Command         []string         `json:"command,omitempty"`
	Args            []string         `json:"args,omitempty"`
	Script          string           `json:"script,omitempty"`
	Env             []EnvVar         `json:"env,omitempty"`
	WorkingDir      string           `json:"workingDir,omitempty"`
	Resources       *StepResources   `json:"resources,omitempty"`
	VolumeMounts    []VolumeMount    `json:"volumeMounts,omitempty"`
	Workspaces      []WorkspaceUsage `json:"workspaces,omitempty"`
	Ports           []ContainerPort  `json:"ports,omitempty"`
	ImagePullPolicy string           `json:"imagePullPolicy,omitempty"`
}

Sidecar is a long-lived helper container that shares the Task's pod/network namespace for the duration of the Task. Mirrors Tekton's v1 Sidecar; tkn-act honors the subset listed below on the docker backend (image, command/args, script, env, workingDir, resources, volumeMounts, workspaces). The cluster backend forwards the full marshalled shape — any other field the controller knows about works under --cluster regardless of what tkn-act reads.

type Step 

type Step struct {
	Name        string `json:"name"`
	DisplayName string `json:"displayName,omitempty"`
	Description string `json:"description,omitempty"`
	// Ref, when set, points to a StepAction whose body is inlined into
	// this Step before substitution. Mutually exclusive with Image /
	// Command / Args / Script / Env / Results: a Step is either inline
	// or a reference. See docs/superpowers/specs/2026-05-04-step-actions-design.md.
	Ref *StepActionRef `json:"ref,omitempty"`
	// Params is the list of values bound into the referenced StepAction's
	// declared params. Ignored when Ref is nil.
	Params          []Param        `json:"params,omitempty"`
	Image           string         `json:"image,omitempty"`
	Command         []string       `json:"command,omitempty"`
	Args            []string       `json:"args,omitempty"`
	Script          string         `json:"script,omitempty"`
	Env             []EnvVar       `json:"env,omitempty"`
	WorkingDir      string         `json:"workingDir,omitempty"`
	Resources       *StepResources `json:"resources,omitempty"`
	ImagePullPolicy string         `json:"imagePullPolicy,omitempty"` // Always | IfNotPresent | Never
	// OnError controls Task-level failure semantics. "" or "stopAndFail" is
	// the default — first non-zero step exit fails the Task. "continue" lets
	// a non-zero exit be recorded but does not fail the Task.
	OnError string `json:"onError,omitempty"`
	// Results are per-step results, mounted at /tekton/steps/<step>/results/
	// in this step (RW) and in every later step in the same Task (RO).
	Results      []ResultSpec  `json:"results,omitempty"`
	VolumeMounts []VolumeMount `json:"volumeMounts,omitempty"`
}

type StepAction added in v1.6.0 

type StepAction struct {
	Object `json:",inline"`
	Spec   StepActionSpec `json:"spec"`
}

StepAction is a referenceable Step shape (apiVersion tekton.dev/v1beta1). Lives in the loader bundle alongside Tasks and Pipelines; resolved into concrete Steps by the engine before stepTemplate merge / substitution.

type StepActionRef added in v1.6.0 

type StepActionRef struct {
	Name string `json:"name"`
}

StepActionRef is the reference written under Step.ref. Only `name` is honored in v1; resolver-based forms (hub / git / cluster / bundles) are deferred to Track 1 #9.

type StepActionSpec added in v1.6.0 

type StepActionSpec struct {
	Description     string         `json:"description,omitempty"`
	Params          []ParamSpec    `json:"params,omitempty"`
	Results         []ResultSpec   `json:"results,omitempty"`
	Image           string         `json:"image"`
	Command         []string       `json:"command,omitempty"`
	Args            []string       `json:"args,omitempty"`
	Script          string         `json:"script,omitempty"`
	Env             []EnvVar       `json:"env,omitempty"`
	WorkingDir      string         `json:"workingDir,omitempty"`
	ImagePullPolicy string         `json:"imagePullPolicy,omitempty"`
	Resources       *StepResources `json:"resources,omitempty"`
	VolumeMounts    []VolumeMount  `json:"volumeMounts,omitempty"`
}

StepActionSpec is the body of a StepAction. It overlaps with Step but is intentionally a separate type so that fields that don't make sense on a referenceable shape (Name, Ref, OnError) are absent. In particular StepActionSpec deliberately has NO Ref field — nested StepAction refs are forbidden by construction (validator rule 15).

type StepResources 

type StepResources struct {
	Limits   ResourceList `json:"limits,omitempty"`
	Requests ResourceList `json:"requests,omitempty"`
}

type StepTemplate added in v1.4.0 

type StepTemplate struct {
	Image           string         `json:"image,omitempty"`
	Command         []string       `json:"command,omitempty"`
	Args            []string       `json:"args,omitempty"`
	Env             []EnvVar       `json:"env,omitempty"`
	WorkingDir      string         `json:"workingDir,omitempty"`
	Resources       *StepResources `json:"resources,omitempty"`
	ImagePullPolicy string         `json:"imagePullPolicy,omitempty"`
}

StepTemplate is the partial-Step template merged into every Step in TaskSpec.Steps. Fields are inherited only when the Step doesn't set its own. Mirrors Tekton's StepTemplate (v1) for the subset of Step fields tkn-act reads. `name`, `script`, `volumeMounts`, `results`, and `onError` are NOT inheritable — they're intrinsically per-Step.

type Task 

type Task struct {
	Object `json:",inline"`
	Spec   TaskSpec `json:"spec"`
}

type TaskRef 

type TaskRef struct {
	Name string `json:"name,omitempty"`
	Kind string `json:"kind,omitempty"` // Task|ClusterTask; default Task
	// Resolver names a Tekton resolver (git | hub | http | bundles |
	// cluster | custom-name-in-remote-mode). When non-empty, Name is
	// ignored — the resolver is authoritative.
	Resolver string `json:"resolver,omitempty"`
	// ResolverParams are the resolver-specific name=value pairs nested
	// inside the `resolver:` block. The YAML key is "params" because
	// Tekton's schema places this list inside `taskRef:`; this is a
	// distinct nesting from PipelineTask.Params.
	ResolverParams []ResolverParam `json:"params,omitempty"`
}

type TaskRun 

type TaskRun struct {
	Object `json:",inline"`
	Spec   TaskRunSpec `json:"spec"`
}

type TaskRunSpec 

type TaskRunSpec struct {
	TaskRef    *TaskRef           `json:"taskRef,omitempty"`
	TaskSpec   *TaskSpec          `json:"taskSpec,omitempty"`
	Params     []Param            `json:"params,omitempty"`
	Workspaces []WorkspaceBinding `json:"workspaces,omitempty"`
}

type TaskSpec 

type TaskSpec struct {
	Params      []ParamSpec     `json:"params,omitempty"`
	Results     []ResultSpec    `json:"results,omitempty"`
	Workspaces  []WorkspaceDecl `json:"workspaces,omitempty"`
	Steps       []Step          `json:"steps"`
	DisplayName string          `json:"displayName,omitempty"`
	Description string          `json:"description,omitempty"`
	// Timeout is a Go duration string (e.g. "30s", "5m"). Empty means no
	// task-level timeout.
	Timeout      string        `json:"timeout,omitempty"`
	Volumes      []Volume      `json:"volumes,omitempty"`
	StepTemplate *StepTemplate `json:"stepTemplate,omitempty"`
	Sidecars     []Sidecar     `json:"sidecars,omitempty"`
}

type Timeouts added in v1.3.0 

type Timeouts struct {
	Pipeline string `json:"pipeline,omitempty"`
	Tasks    string `json:"tasks,omitempty"`
	Finally  string `json:"finally,omitempty"`
}

Timeouts mirrors Tekton's PipelineSpec.Timeouts (tekton.dev/v1).

Each field is a Go-style time.Duration string (e.g. "30s", "5m", "2h"). Unset fields mean "no budget at this level". Validator enforces: durations parseable, none equals zero, and tasks+finally ≤ pipeline when all three are set.

type Volume added in v1.2.0 

type Volume struct {
	Name      string           `json:"name"`
	EmptyDir  *EmptyDirSource  `json:"emptyDir,omitempty"`
	HostPath  *HostPathSource  `json:"hostPath,omitempty"`
	ConfigMap *ConfigMapSource `json:"configMap,omitempty"`
	Secret    *SecretSource    `json:"secret,omitempty"`
}

Volume is a Task-level volume. Exactly one of EmptyDir/HostPath/ConfigMap/ Secret must be set; any other source kind is rejected by the validator.

type VolumeMount added in v1.2.0 

type VolumeMount struct {
	Name      string `json:"name"`
	MountPath string `json:"mountPath"`
	ReadOnly  bool   `json:"readOnly,omitempty"`
	SubPath   string `json:"subPath,omitempty"`
}

type WhenExpression 

type WhenExpression struct {
	Input    string   `json:"input"`
	Operator string   `json:"operator"` // "in" | "notin"
	Values   []string `json:"values"`
}

type WorkspaceBinding 

type WorkspaceBinding struct {
	Name      string `json:"name"`      // workspace name as declared in the Task
	Workspace string `json:"workspace"` // pipeline workspace it binds to
	SubPath   string `json:"subPath,omitempty"`
}

type WorkspaceDecl 

type WorkspaceDecl struct {
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
	MountPath   string `json:"mountPath,omitempty"`
	ReadOnly    bool   `json:"readOnly,omitempty"`
	Optional    bool   `json:"optional,omitempty"`
}

type WorkspaceUsage added in v1.6.0 

type WorkspaceUsage struct {
	Name      string `json:"name"`
	MountPath string `json:"mountPath,omitempty"`
	SubPath   string `json:"subPath,omitempty"`
}

WorkspaceUsage is the per-container workspace declaration used by Sidecar. Tekton's Step takes its workspace bindings from the PipelineTask, so this type is sidecar-only for now.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.