Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openshift-pipelines/pipelines-as-code
Pipelines-as-Code for Tekton
https://github.com/openshift-pipelines/pipelines-as-code
bitbucket ci continuous-delivery github gitlab gitops kubernetes pipeline pipelines-as-code tekton tekton-pipelines
Last synced: 4 days ago
JSON representation
Pipelines-as-Code for Tekton
- Host: GitHub
- URL: https://github.com/openshift-pipelines/pipelines-as-code
- Owner: openshift-pipelines
- License: apache-2.0
- Created: 2021-04-06T13:26:01.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T15:25:23.000Z (10 months ago)
- Last Synced: 2024-04-12T16:58:12.264Z (10 months ago)
- Topics: bitbucket, ci, continuous-delivery, github, gitlab, gitops, kubernetes, pipeline, pipelines-as-code, tekton, tekton-pipelines
- Language: Go
- Homepage: https://pipelinesascode.com
- Size: 35.4 MB
- Stars: 117
- Watchers: 7
- Forks: 76
- Open Issues: 83
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# Pipelines-as-Code
[](https://github.com/openshift-pipelines/pipelines-as-code/pkgs/container/pipelines-as-code) [](https://codecov.io/gh/openshift-pipelines/pipelines-as-code) [](https://goreportcard.com/report/openshift-pipelines/pipelines-as-code) [](https://github.com/openshift-pipelines/pipelines-as-code/actions/workflows/kind-e2e-tests.yaml)
Pipelines-as-Code -- An opinionated CI based on OpenShift Pipelines / Tekton.
Full documentation for the stable version is available from
Documentation for the development branch is available [here](https://nightly.pipelines-as-code.pages.dev/)
## Introduction
Pipelines-as-Code let you use
the [Pipelines-as-Code flow]([https://www.thoughtworks.com/radar/techniques/pipelines-as-code](https://www.thoughtworks.com/radar/techniques/pipelines-as-code)) directly with Tekton and OpenShift Pipelines.
The goal of Pipelines-as-Code is to let you define your
[Tekton](https://tekton.dev) templates inside your source code repository and have the pipeline run and report the status
of the execution when triggered by a Pull Request or a Push.
Pipelines-as-Code features:
- Pull-request status support: When iterating over a Pull Request, status and control is done on the platform.
- GitHub Checks API support to set the status of a PipelineRun including rechecks
- GitHub Pull Request and Commit event support
- Pull-request actions in comments such as `/retest`
- Git events filtering and support for separate pipelines for each event
- Automatic Task resolution in Pipelines (local Tasks, Tekton Hub and remote URLs)
- Efficient use of GitHub blobs and objects API for retrieving configurations
- ACL over a GitHub organization or with a Prow style [`OWNER`](https://www.kubernetes.dev/docs/guide/owners/) file.
- `tkn-pac` plug-in for Tekton CLI for managing pipelines-as-code repositories and bootstrapping.
- GitLab, Bitbucket Server, Bitbucket Cloud and GitHub through Webhook support.
## Installation Guide
The easiest way to get started is to use the `tkn pac` CLI and its bootstrap command.
Download and install first the tkn-pac CLI following [these instructions](/docs/content/docs/guide/cli.md#install).
Connected to your cluster execute the command :
```bash
-$ tkn pac bootstrap
```
and follow the questions and installation methods which will install Pipelines-as-Code on cluster and help you create a GitHub Application.
feel free to look over the `--help` to see the different options on how to install for example on GitHub Enterprise.
This getting started video will guide you thought the `tkn-pac bootstrap` flow using [Kind](https://kind.sigs.k8s.io/) :
[](https://www.youtube.com/watch?v=cNOqPgpRXQY)
For more details on the different installation method please follow [this document](https://pipelinesascode.com/docs/install/overview/) for installing Pipelines-as-Code on OpenShift.
## Getting Started
The flow for using pipelines as code generally begins with admin installing the Pipelines-as-Code infrastructure,
creating a GitHub App and sharing the GitHub App URL across the organization for app teams to enable the app on their
GitHub repositories.
Start creating a GitHub repository by going to this URL
, you will need to provide a name (eg: `pac-demo`) and check
the `"[ ] Add a README file"` box before pressing the `"Create Repository"` button.
You are now able to enable the `Pipelines-as-Code` GitHub Application as created
by the Admin onto your new repository by following this guide
[here](https://docs.github.com/en/developers/apps/managing-github-apps/installing-github-apps).
Once you have enabled your GitHub App for your GitHub repository, you can use
the Tekton CLI [pac plug-in](https://pipelinesascode.com/docs/guide/cli/#install)
to bootstrap pipelines as code:
```bash
$ git clone https://github.com/youruser/pac-demo
$ cd pac-demo
$ tkn pac create repository
? Enter the Git repository url containing the pipelines (default: https://github.com/youruser/pac-demo):
? Please enter the namespace where the pipeline should run (default: pac-demo):
! Namespace pac-demo is not found
? Would you like me to create the namespace pac-demo? Yes
✓ Repository youruser-pac-demo has been created in pac-demo namespace
ℹ Directory .tekton has been created.
✓ A basic template has been created in .tekton/pipelinerun.yaml, feel free to customize it.
ℹ You can test your pipeline by pushing the generated template to your git repository
```
The above command would create a `Repository` CRD in your `demo` namespace which is used to determine where the
PipelineRuns for your GitHub repository should run. It also generates an example pipeline in the `.tekton` folder.
Commit and push the pipeline to your repo to start using pipelines as code.
Note that even if installing with GitHub application is the preferred installation method, Pipeline As Code
supports other methods :
- GitHub direct Webhook
- GitLab public and private instances.
- Bitbucket Cloud
- Bitbucket Server
You can use the command `tkn pac webhook` to help you update webhooks on your repository. See the [INSTALL guide](https://pipelinesascode.com/docs/install/) for more details on each install method.
## Usage Guide
The usage guide available [here](https://pipelinesascode.com/docs/guide/) offer
a comprehensive documentation on how to use and configure Pipeline As Code.
## Contributing
We ❤️ our contributors!
If you want to help and contribute to the `pipelines-as-code` project, you can
see the documentation here to get started:
(and thank you).
## Getting in touch
There are several ways to communicate with us:
- Subscribe to the [community calendar](https://calendar.google.com/calendar/embed?src=53eb8e69e3a902ea3a31fe6795f69df165d9bb22a8ab11ed5c9cbd27ee654742%40group.calendar.google.com) for community meetings and events
- Slack Channel - [#pipelinesascode channel](https://tektoncd.slack.com/archives/C04URDDJ9MZ) on the [TektonCD community Slack](https://github.com/tektoncd/community/blob/main/contact.md#slack)
## Videos/Blog Posts
- [OpenShift Developer Experience Office Hours: Pipelines-as-Code with OpenShift Pipelines](https://www.youtube.com/watch?v=PhqzGsJnFEI)
- [How to make a release pipeline with Pipelines-as-Code](https://blog.chmouel.com/2021/07/01/how-to-make-a-release-pipeline-with-pipelines-as-code)
- Main branch documentation -