examples/v1/pipelineruns/README.md
This directory contains example PipelineRun configurations demonstrating various features of Tekton Pipelines. These examples showcase how to define, configure, and run pipelines with different capabilities such as parameters, workspaces, results, conditional execution, and advanced execution patterns.
These files are intended as reference implementations to help users understand how different PipelineRun configurations work in practice.
Before running these examples, ensure the following components are installed and configured:
You need access to a running Kubernetes cluster. This can be a local cluster (e.g. Kind, Minikube) or a managed cluster from a cloud provider.
Tekton Pipelines must be installed in the cluster, as these examples rely on Tekton custom resources such as Pipeline, Task, and PipelineRun.
Installation instructions:
https://tekton.dev/docs/pipelines/install/
The Kubernetes CLI (kubectl) must be installed and configured to communicate with your cluster.
Documentation:
https://kubernetes.io/docs/tasks/tools/
The Tekton CLI (tkn) is useful for inspecting PipelineRuns and streaming logs.
Installation instructions:
https://tekton.dev/docs/cli/
Some examples may require specific Tekton feature flags to be enabled depending on the functionality being demonstrated.
Some examples in this directory define a PipelineRun resource that can be created directly in your Kubernetes cluster.
If the file defines a fixed metadata.name, you can run it with:
kubectl apply -f <file>.yaml
Some examples instead use metadata.generateName. This allows the resource to be created multiple times with unique names.
For these files you should use:
kubectl create -f <file>.yaml
Using kubectl apply on resources that use generateName will fail because apply requires a fixed resource name.
After creating a PipelineRun, you can inspect it with:
kubectl get pipelineruns
kubectl describe pipelinerun <name>
You can also view logs for a PipelineRun using the Tekton CLI (tkn):
tkn pipelinerun logs <name> -f
Simple PipelineRun examples demonstrating basic pipeline execution.
Examples demonstrating how parameters and results are passed between pipelines and tasks.
Examples demonstrating how workspaces are used to share data between tasks.
Examples showing how to conditionally run tasks based on when expressions.
Examples demonstrating inline pipeline or task specifications.
Examples illustrating pipeline execution behavior and reporting.
Examples demonstrating the use of final tasks and pipeline results.
Examples demonstrating the use of StepActions.
Examples demonstrating display name usage.
Examples created to validate bug fixes or regression scenarios.