# Functions
ArrayReference returns the name of the parameter from array parameter reference returns arrayParam from $(params.arrayParam[*]).
ExtractStepResultName extracts the step name and result name from a string matching formtat $(steps.<stepName>.results.<resultName>).
No description provided by the author
Kind takes an unqualified kind and returns back a Group qualified GroupKind.
LooksLikeContainsResultRefs attempts to check if param or a pipeline result looks like it contains any result references.
MergeSidecarsWithSpecs takes a possibly nil list of overrides and a list of sidecars, merging each of the sidecars with the overrides' resource requirements, if it's not nil, and returning the resulting list.
MergeStepsWithSpecs takes a possibly nil list of overrides and a list of steps, merging each of the steps with the overrides' resource requirements, if it's not nil, and returning the resulting list.
MergeStepsWithStepTemplate takes a possibly nil container template and a list of steps, merging each of the steps with the container template, if it's not nil, and returning the resulting list.
NewObject creates an ParamValues of type ParamTypeObject using the provided key-value pairs.
NewResultRefs extracts all ResultReferences from a param or a pipeline result.
NewStructuredValues creates an ParamValues of type ParamTypeString or ParamTypeArray, based on how many inputs are given (>1 input will create an array, not string).
ParseResultName parse the input string to extract resultName and result index.
PipelineTaskResultRefs walks all the places a result reference can be used in a PipelineTask and returns a list of any references that are found.
RefNameLikeUrl checks if the name is url parsable and returns an error if it isn't.
Resource takes an unqualified resource and returns a Group qualified GroupResource.
ResultsArrayReference returns the reference of the result.
ValidateNameFormat validates that the name format of all param types follows the rules.
ValidateObjectParamsHaveProperties returns an error if any declared object params are missing properties.
ValidateParameters makes sure the params for the Task are valid.
ValidateParameterTypes validates all the types within a slice of ParamSpecs.
ValidateParameterVariables validates all variables within a slice of ParamSpecs against a slice of Steps.
ValidatePipelineParameterVariables validates parameters with those specified by each pipeline task, (1) it validates the type of parameter is either string or array (2) parameter default value matches with the type of that param (3) no duplication, feature flag and allowed param type when using param enum.
ValidatePipelineTasks ensures that pipeline tasks has unique label, pipeline tasks has specified one of taskRef or taskSpec, and in case of a pipeline task with taskRef, it has a reference to a valid task (task name).
ValidateStepResults validates that all of the declared StepResults are valid.
ValidateStepResultsVariables validates if the StepResults referenced in step script are defined in step's results.
ValidateUsageOfDeclaredParameters validates that all parameters referenced in the Task are declared by the Task.
ValidateVolumes validates a slice of volumes to make sure there are no dupilcate names.
ValidateWorkspaceBindings makes sure the volumes provided for the Task's declared workspaces make sense.
# Constants
ClusterTaskRefKind is the task type for a reference to a task with cluster scope.
Continue indicates continue executing the rest of the steps irrespective of the container exit code.
EmptyArrayInMatrixParams means the task was skipped because Matrix parameters contain empty array.
EnabledOnFailureBreakpoint is the value for TaskRunDebug.Breakpoints.OnFailure that means the breakpoint onFailure is enabled.
FinallyTimedOutSkip means the task was skipped because the PipelineRun has passed its Timeouts.Finally.
GracefullyCancelledSkip means the task was skipped because the pipeline run has been gracefully cancelled.
GracefullyStoppedSkip means the task was skipped because the pipeline run has been gracefully stopped.
ManagedByLabelKey is the label key used to mark what is managing this resource.
MissingResultsSkip means the task was skipped because it's missing necessary results.
NamespacedTaskKind indicates that the task type has a namespaced scope.
None means the task was not skipped.
ParamsPrefix is the prefix used in $(...) expressions referring to parameters.
Valid ParamTypes:.
Valid ParamTypes:.
Valid ParamTypes:.
ParentTasksSkip means the task was skipped because its parent was skipped.
PipelineFinallyTasks is a value representing a task is a member of "finally" section of the pipeline.
PipelineRunReasonCancelled is the reason set when the PipelineRun cancelled by the user This reason may be found with a corev1.ConditionFalse status, if the cancellation was processed successfully This reason may be found with a corev1.ConditionUnknown status, if the cancellation is being processed or failed.
PipelineRunReasonCancelledRunningFinally indicates that pipeline has been gracefully cancelled and no new Tasks will be scheduled by the controller, but final tasks are now running.
ReasonCELEvaluationFailed indicates the pipeline fails the CEL evaluation.
PipelineRunReasonCompleted is the reason set when the PipelineRun completed successfully with one or more skipped Tasks.
ReasonCouldntCancel indicates that a PipelineRun was cancelled but attempting to update all of the running TaskRuns as cancelled failed.
ReasonCouldntGetPipeline indicates that the reason for the failure status is that the associated Pipeline couldn't be retrieved.
PipelineRunReasonCouldntGetPipelineResult indicates that the pipeline fails to retrieve the referenced result.
ReasonCouldntGetTask indicates that the reason for the failure status is that the associated Pipeline's Tasks couldn't all be retrieved.
ReasonCouldntTimeOut indicates that a PipelineRun was timed out but attempting to update all of the running TaskRuns as timed out failed.
ReasonCreateRunFailed indicates that the pipeline fails to create the taskrun or other run resources.
PipelineRunReasonFailed is the reason set when the PipelineRun completed with a failure.
ReasonFailedValidation indicates that the reason for failure status is that pipelinerun failed runtime validation.
ReasonInvalidBindings indicates that the reason for the failure status is that the PipelineResources bound in the PipelineRun didn't match those declared in the Pipeline.
ReasonInvalidGraph indicates that the reason for the failure status is that the associated Pipeline is an invalid graph (a.k.a wrong order, cycle, …).
ReasonInvalidMatrixParameterTypes indicates a matrix contains invalid parameter types.
PipelineRunReasonInvalidParamValue indicates that the PipelineRun Param input value is not allowed.
PipelineRunReasonInvalidPipelineResultReference indicates a pipeline result was declared by the pipeline but not initialized in the pipelineTask.
ReasonInvalidTaskResultReference indicates a task result was declared but was not initialized by that task.
ReasonInvalidTaskRunSpec indicates that PipelineRun.Spec.TaskRunSpecs[].PipelineTaskName is defined with a not exist taskName in pipelineSpec.
ReasonInvalidWorkspaceBinding indicates that a Pipeline expects a workspace but a PipelineRun has provided an invalid binding.
ReasonObjectParameterMissKeys indicates that the object param value provided from PipelineRun spec misses some keys required for the object param declared in Pipeline spec.
ReasonParamArrayIndexingInvalid indicates that the use of param array indexing is out of bound.
ReasonParameterMissing indicates that the reason for the failure status is that the associated PipelineRun didn't provide all the required parameters.
ReasonParameterTypeMismatch indicates that the reason for the failure status is that parameter(s) declared in the PipelineRun do not have the some declared type as the parameters(s) declared in the Pipeline that they are supposed to override.
PipelineRunReasonPending is the reason set when the PipelineRun is in the pending state.
ReasonRequiredWorkspaceMarkedOptional indicates an optional workspace has been passed to a Task that is expecting a non-optional workspace.
ReasonResolvingPipelineRef indicates that the PipelineRun is waiting for its pipelineRef to be asynchronously resolved.
ReasonResourceVerificationFailed indicates that the pipeline fails the trusted resource verification, it could be the content has changed, signature is invalid or public key is invalid.
PipelineRunReasonRunning is the reason set when the PipelineRun is running.
PipelineRunReasonStarted is the reason set when the PipelineRun has just started.
PipelineRunReasonStoppedRunningFinally indicates that pipeline has been gracefully stopped and no new Tasks will be scheduled by the controller, but final tasks are now running.
PipelineRunReasonStopping indicates that no new Tasks will be scheduled by the controller, and the pipeline will stop once all running tasks complete their work.
PipelineRunReasonSuccessful is the reason set when the PipelineRun completed successfully.
PipelineRunReasonTimedOut is the reason set when the PipelineRun has timed out.
PipelineRunSpecStatusCancelled indicates that the user wants to cancel the task, if not already cancelled or terminated.
PipelineRunSpecStatusCancelledRunFinally indicates that the user wants to cancel the pipeline run, if not already cancelled or terminated, but ensure finally is run normally.
PipelineRunSpecStatusPending indicates that the user wants to postpone starting a PipelineRun until some condition is met.
PipelineRunSpecStatusStoppedRunFinally indicates that the user wants to stop the pipeline run, wait for already running tasks to be completed and run finally if not already cancelled or terminated.
PipelineTaskContinue indicates to continue executing the rest of the DAG when the PipelineTask fails.
PipelineTaskOnErrorAnnotation is used to pass the failure strategy to TaskRun pods from PipelineTask OnError field.
PipelineTasks is a value representing a task is a member of "tasks" section of the pipeline.
PipelineTasksAggregateStatus is a param representing aggregate status of all dag pipelineTasks.
PipelineTaskStopAndFail indicates to stop and fail the PipelineRun if the PipelineTask fails.
PipelineTimedOutSkip means the task was skipped because the PipelineRun has passed its overall timeout.
ResultFinallyPart Constant used to define the "finally" part of a pipeline result reference retained because of backwards compatibility.
ResultNameFormat Constant used to define the regex Result.Name should follow.
ResultResultPart Constant used to define the "results" part of a pipeline result reference retained because of backwards compatibility.
Valid ResultsType:.
Valid ResultsType:.
Valid ResultsType:.
ResultTaskPart Constant used to define the "tasks" part of a pipeline result reference retained because of backwards compatibility.
StopAndFail indicates exit the taskRun if the container exits with non-zero exit code.
StoppingSkip means the task was skipped because the pipeline run is stopping.
TaskRunCancelledByPipelineMsg indicates that the PipelineRun of which this TaskRun was a part of has been cancelled.
TaskRunCancelledByPipelineTimeoutMsg indicates that the TaskRun was cancelled because the PipelineRun running it timed out.
TaskRunReasonCancelled is the reason set when the TaskRun is cancelled by the user.
TaskRunReasonFailed is the reason set when the TaskRun completed with a failure.
TaskRunReasonFailedResolution indicated that the reason for failure status is that references within the TaskRun could not be resolved.
TaskRunReasonFailedValidation indicated that the reason for failure status is that taskrun failed runtime validation.
TaskRunReasonFailureIgnored is the reason set when the Taskrun has failed due to pod execution error and the failure is ignored for the owning PipelineRun.
TaskRunReasonImagePullFailed is the reason set when the step of a task fails due to image not being pulled.
TaskRunReasonInvalidParamValue indicates that the TaskRun Param input value is not allowed.
TaskRunReasonResolvingStepActionRef indicates that the TaskRun is waiting for its StepAction's Ref to be asynchronously resolved.
TaskRunReasonResolvingTaskRef indicates that the TaskRun is waiting for its taskRef to be asynchronously resolved.
TaskRunReasonResourceVerificationFailed indicates that the task fails the trusted resource verification, it could be the content has changed, signature is invalid or public key is invalid.
TaskRunReasonResultLargerThanAllowedLimit is the reason set when one of the results exceeds its maximum allowed limit of 1 KB.
TaskRunReasonRunning is the reason set when the TaskRun is running.
TaskRunReasonStarted is the reason set when the TaskRun has just started.
TaskRunReasonStopSidecarFailed indicates that the sidecar is not properly stopped.
TaskRunReasonSuccessful is the reason set when the TaskRun completed successfully.
TaskRunReasonTaskFailedValidation indicated that the reason for failure status is that task failed runtime validation.
TaskRunReasonTimedOut is the reason set when one TaskRun execution has timed out.
TaskRunReasonToBeRetried is the reason set when the last TaskRun execution failed, and will be retried.
TaskRunSpecStatusCancelled indicates that the user wants to cancel the task, if not already cancelled or terminated.
TasksTimedOutSkip means the task was skipped because the PipelineRun has passed its Timeouts.Tasks.
WhenExpressionsSkip means the task was skipped due to at least one of its when expressions evaluating to false.
# Variables
AddToScheme adds Build types to the scheme.
AllParamTypes can be used for ParamType validation.
AllResultsTypes can be used for ResultsTypes validation.
SchemeGroupVersion is group version used to register these objects.
VariableSubstitutionRegex is a regex to find all result matching substitutions.
# Structs
Artifact represents an artifact within a system, potentially containing multiple values associated with it.
Artifacts represents the collection of input and output artifacts associated with a task run or a similar process.
ArtifactValue represents a specific value or data element within an Artifact.
ChildStatusReference is used to point to the statuses of individual TaskRuns and Runs within this PipelineRun.
EmbeddedTask is used to define a Task inline within a Pipeline's PipelineTasks.
IncludeParams allows passing in a specific combinations of Parameters into the Matrix.
Matrix is used to fan out Tasks in a Pipeline.
Param declares an ParamValues to use for the parameter called name.
ParamSpec defines arbitrary parameters needed beyond typed inputs (such as resources).
ParamValue is a type that can hold a single string, string array, or string map.
Pipeline describes a list of Tasks to execute.
PipelineList contains a list of Pipeline.
PipelineRef can be used to refer to a specific instance of a Pipeline.
PipelineResult used to describe the results of a pipeline.
PipelineRun represents a single execution of a Pipeline.
PipelineRunList contains a list of PipelineRun.
PipelineRunResult used to describe the results of a pipeline.
PipelineRunRunStatus contains the name of the PipelineTask for this Run and the Run's Status.
PipelineRunSpec defines the desired state of PipelineRun.
PipelineRunStatus defines the observed state of PipelineRun.
PipelineRunStatusFields holds the fields of PipelineRunStatus' status.
PipelineRunTaskRunStatus contains the name of the PipelineTask for this TaskRun and the TaskRun's Status.
PipelineSpec defines the desired state of Pipeline.
PipelineTask defines a task in a Pipeline, passing inputs from both Params and from the output of previous tasks.
PipelineTaskMetadata contains the labels or annotations for an EmbeddedTask.
PipelineTaskParam is used to provide arbitrary string parameters to a Task.
PipelineTaskRun reports the results of running a step in the Task.
PipelineTaskRunSpec can be used to configure specific specs for a concrete Task.
PipelineTaskRunTemplate is used to specify run specifications for all Task in pipelinerun.
PipelineWorkspaceDeclaration creates a named slot in a Pipeline that a PipelineRun is expected to populate with a workspace binding.
PropertySpec defines the struct for object keys.
Provenance contains metadata about resources used in the TaskRun/PipelineRun such as the source from where a remote build definition was fetched.
Ref can be used to refer to a specific instance of a StepAction.
RefSource contains the information that can uniquely identify where a remote built definition came from i.e.
ResolverRef can be used to refer to a Pipeline or Task in a remote location like a git repo.
ResultRef is a type that represents a reference to a task run result.
Sidecar has nearly the same data structure as Step but does not have the ability to timeout.
SidecarState reports the results of running a sidecar in a Task.
SkippedTask is used to describe the Tasks that were skipped due to their When Expressions evaluating to False.
Step runs a subcomponent of a Task.
StepOutputConfig stores configuration for a step output stream.
StepResult used to describe the Results of a Step.
StepState reports the results of running a step in a Task.
StepTemplate is a template for a Step.
Task represents a collection of sequential steps that are run as part of a Pipeline using a set of inputs and producing a set of outputs.
TaskBreakpoints defines the breakpoint config for a particular Task.
TaskList contains a list of Task +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
TaskRef can be used to refer to a specific instance of a task.
TaskResult used to describe the results of a task.
TaskRun represents a single execution of a Task.
TaskRunDebug defines the breakpoint config for a particular TaskRun.
TaskRunInputs holds the input values that this task was invoked with.
TaskRunList contains a list of TaskRun.
TaskRunResult used to describe the results of a task.
TaskRunSidecarSpec is used to override the values of a Sidecar in the corresponding Task.
TaskRunSpec defines the desired state of TaskRun.
TaskRunStatus defines the observed state of TaskRun.
TaskRunStatusFields holds the fields of TaskRun's status.
TaskRunStepSpec is used to override the values of a Step in the corresponding Task.
TaskSpec defines the desired state of Task.
TimeoutFields allows granular specification of pipeline, task, and finally timeouts.
WhenExpression allows a PipelineTask to declare expressions to be evaluated before the Task is run to determine whether the Task should be executed or skipped.
WorkspaceBinding maps a Task's declared workspace to a Volume.
WorkspaceDeclaration is a declaration of a volume that a Task requires.
WorkspacePipelineTaskBinding describes how a workspace passed into the pipeline should be mapped to a task's declared workspace.
WorkspaceUsage is used by a Step or Sidecar to declare that it wants isolated access to a Workspace defined in a Task.
# Type aliases
Algorithm Standard cryptographic hash algorithm.
Combination is a map, mainly defined to hold a single combination from a Matrix with key as param.Name and value as param.Value.
Combinations is a Combination list.
IncludeParamsList is a list of IncludeParams which allows passing in specific combinations of Parameters into the Matrix.
OnErrorType defines a list of supported exiting behavior of a container on error.
Params is a list of Param.
ParamSpecs is a list of ParamSpec.
ParamType indicates the type of an input parameter; Used to distinguish between a single string and an array of strings.
PipelineRunReason represents a reason for the pipeline run "Succeeded" condition.
PipelineRunSpecStatus defines the pipelinerun spec status the user can provide.
PipelineTaskList is a list of PipelineTasks.
PipelineTaskOnErrorType defines a list of supported failure handling behaviors of a PipelineTask on error.
ResolverName is the name of a resolver from which a resource can be requested.
ResultsType indicates the type of a result; Used to distinguish between a single string and an array of strings.
ResultValue is a type alias of ParamValue.
SkippingReason explains why a PipelineTask was skipped.
No description provided by the author
TaskKind defines the type of Task used by the pipeline.
TaskRunReason is an enum used to store all TaskRun reason for the Succeeded condition that are controlled by the TaskRun itself.
TaskRunSpecStatus defines the TaskRun spec status the user can provide.
TaskRunSpecStatusMessage defines human readable status messages for the TaskRun.
TaskRunStepArtifact represents an artifact produced or used by a step within a task run.
TaskRunStepResult is a type alias of TaskRunResult.
WhenExpressions are used to specify whether a Task should be executed or skipped All of them need to evaluate to True for a guarded Task to be executed.
WorkspacePipelineDeclaration creates a named slot in a Pipeline that a PipelineRun is expected to populate with a workspace binding.