{"id":21822426,"url":"https://github.com/openshift-pipelines/setup-tektoncd","last_synced_at":"2025-10-08T04:30:34.239Z","repository":{"id":142612145,"uuid":"613801652","full_name":"openshift-pipelines/setup-tektoncd","owner":"openshift-pipelines","description":"GitHub Action to rollout Tekton Pipeline and auxiliary components","archived":false,"fork":false,"pushed_at":"2025-08-12T08:30:40.000Z","size":25,"stargazers_count":0,"open_issues_count":1,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-12T10:24:39.666Z","etag":null,"topics":["actions","pipeline","tektoncd"],"latest_commit_sha":null,"homepage":"https://github.com/tektoncd/pipeline","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openshift-pipelines.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-03-14T09:52:22.000Z","updated_at":"2025-08-12T08:30:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"63e89ec2-fa8a-4c0e-88bb-07d66f35fc69","html_url":"https://github.com/openshift-pipelines/setup-tektoncd","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/openshift-pipelines/setup-tektoncd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift-pipelines%2Fsetup-tektoncd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift-pipelines%2Fsetup-tektoncd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift-pipelines%2Fsetup-tektoncd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift-pipelines%2Fsetup-tektoncd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openshift-pipelines","download_url":"https://codeload.github.com/openshift-pipelines/setup-tektoncd/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift-pipelines%2Fsetup-tektoncd/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278891480,"owners_count":26063854,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","pipeline","tektoncd"],"created_at":"2024-11-27T17:15:01.619Z","updated_at":"2025-10-08T04:30:33.948Z","avatar_url":"https://github.com/openshift-pipelines.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![use-action][useActionWorkflowBadge]][useActionWorkflow]\n\n`setup-tektoncd`\n----------------\n\nAction to rollout [Tekton Pipeline][githubTektonPipeline], [CLI (`tkn`)][githubTektonCLI] and a [Container-Registry][containerRegistry] instance, setting up the environment for testing using these components.\n\n# GitHub Action Usage\n\nExample usage below with inputs using default values:\n\n```yaml\n---\njobs:\n  setup-tektoncd:\n    steps:\n      # using KinD to provide the Kubernetes instance and kubectl\n      - uses: helm/kind-action@v1.5.0\n        with:\n          cluster_name: kind\n\n      # setting up Tekton Pipelines, CLI and additional components...\n      - uses: openshift-pipelines/setup-tektoncd@v1\n        with:\n          pipeline_version: latest\n          feature_flags: '{}'\n          cli_version: latest\n          setup_registry: \"true\"\n          patch_etc_hosts: \"true\"\n```\n\nThe action uses the current Kubernetes instance available ([KinD][sigsKinD] for example), thus requires `kubectl` on the `${PATH}`.\n\n## Inputs\n\n| Input               | Required | Description                                     |\n|:--------------------|:--------:|:------------------------------------------------|\n| `pipeline_version`  | `false`  | Tekton Pipeline version                         |\n| `feature_flags`     | `false`  | Tekton Pipeline feature flags (JSON) payload    |\n| `cli_version`       | `false`  | Tekton CLI (tkn) version                        |\n| `setup_registry`    | `false`  | Rollout a Container-Registry (v2)               |\n| `patch_etc_hosts`   | `false`  | Add Container-Registry hostname to `/etc/hosts` |\n\n# Components\n\n## Tekton Pipelines\n\n[Tekton Pipelines][githubTektonPipeline] is deployed on the namespace `tekton-pipelines` and the involved deployments are followed until completion, so the setup process waits until the instances are available and in case of error the workflow is interrupted.\n\n### Feature-Flags\n\nTekton Pipelines exposes [feature-flags][githubTektonFeatureFlags] using a `ConfigMap` named `feature-flags`. These flags can be set using the the input `feature_flags`, a JSON formated string containing the the respective flags and values. For example:\n\n```yaml\n---\njobs:\n  setup-tektoncd:\n    steps:\n      - uses: openshift-pipelines/setup-tektoncd@v1\n        with:\n          feature_flags: '{ \"enable-custom-tasks\": \"true\" }'\n```\n\nThe result is observed on the following example:\n\n```\n$ kubectl --namespace=tekton-pipelines get configmap feature-flags --output=json |jq '.data'\n{\n  // ...\n  \"enable-custom-tasks\": \"true\",\n  // ...\n}\n```\n\n## CLI (`tkn`)\n\n[Tekton CLI][githubTektonCLI] is installed on `/usr/local/bin` directory and uses the same Kubernetes context than `kubectl`.\n\n## Container-Registry\n\nA [Container-Registry][containerRegistry] instance is deployed on the `registry` namespace using the same rollout approach than Tekton Pipelines.\n\nThe registry is available on port `32222` and uses the Kubernetes internal service hostname, `registry.registry.svc.cluster.local`, which means the fully qualified container images (plus tag) will look like the example below:\n\n```text\nregistry.registry.svc.cluster.local:32222/namespace/project:tag\n```\n\nThe registry does not require authentication, uses HTTP protocol, is available outside of the Kubernetes instance as well. The Action Input `patch_etc_hosts` makes the registry hostname resolve to `127.0.0.1` and the service exposes the port `32222` as a `hostPort` too.\n\n# Scripts\n\nAlternatively, you can run the scripts directly to rollout Tekton Pipelines and the other components, the recommended approach is using a `.env` file with the required [inputs](./inputs.sh).\n\n```bash\ncat \u003e.env \u003c\u003cEOS\nexport INPUT_PIPELINE_VERSION=\"latest\"\nexport INPUT_CLI_VERSION=\"latest\"\nexport INPUT_FEATURE_FLAGS='{ \"enable-custom-tasks\": \"true\" }'\nEOS\n```\n\nThere are shell plugins to automatically load the `.env` file, once the required environment variables are set you can invoke each script individually:\n\n```bash\nsource .env\n\n./install-pipeline.sh\n./install-registry.sh\n\nsudo ./install-cli.sh\n```\n\nThe script name reflects the component deployed and they are idempotent, you can run them more than once without side effects.\n\n[containerRegistry]: https://docs.docker.com/registry/spec/api/\n[githubTektonCLI]: https://github.com/tektoncd/cli\n[githubTektonFeatureFlags]: https://github.com/tektoncd/pipeline/blob/main/config/config-feature-flags.yaml\n[githubTektonPipeline]: https://github.com/tektoncd/pipeline\n[sigsKinD]: https://kind.sigs.k8s.io\n[useActionWorkflow]: https://github.com/openshift-pipelines/setup-tektoncd/actions/workflows/use-action.yaml\n[useActionWorkflowBadge]: https://github.com/openshift-pipelines/setup-tektoncd/actions/workflows/use-action.yaml/badge.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenshift-pipelines%2Fsetup-tektoncd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenshift-pipelines%2Fsetup-tektoncd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenshift-pipelines%2Fsetup-tektoncd/lists"}