You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
With {pac}, cluster administrators and users with the required privileges can define pipeline templates as part of source code Git repositories. When triggered by a source code push or a pull request for the configured Git repository, the feature runs the pipeline and reports the status.
After installing {pac}, cluster administrators can configure a Git repository hosting service provider. Currently, the following services are supported:
38
-
39
-
* GitHub App
40
-
* GitHub Webhook
41
-
* GitLab
42
-
* Bitbucket Server
43
-
* Bitbucket Cloud
44
-
45
-
[NOTE]
46
-
====
47
-
GitHub App is the recommended service for using with {pac}.
* link:https://docs.github.com/en/developers/webhooks-and-events/webhooks/creating-webhooks[GitHub Webhook documentation on GitHub]
59
-
* link:https://docs.github.com/en/rest/guides/getting-started-with-the-checks-api[GitHub Check Runs documentation on GitHub]
60
-
* link:https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token[Creating a personal access token on GitHub]
61
-
* link:https://github.com/settings/tokens/new?description=pipelines-as-code-token&scopes=repo[Classic tokens with pre-filled permissions]
* link:https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/[Create app password on Bitbucket Cloud]
74
-
* link:https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#introducing-atlassian-account-id-and-nicknames[Introducing Altassian Account ID and Nicknames]
* link:https://github.com/chmouel/tekton-slack-task-status[An example task to send Slack messages on success or failure]
112
-
* link:https://github.com/openshift-pipelines/pipelines-as-code/blob/7b41cc3f769af40a84b7ead41c6f037637e95070/.tekton/push.yaml[An example of a pipeline run with `finally` tasks triggered on push events]
* link:https://github.com/openshift-pipelines/pipelines-as-code/blob/main/test/testdata/pipelinerun_git_clone_private.yaml[An example of the `git-clone` task used for cloning private repositories]
* link:https://github.com/openshift-pipelines/pipelines-as-code/tree/main/.tekton[An example of the `.tekton/` directory in the Pipelines as Code repository]
= Configuring {pac} for a Git repository hosting service provider
8
+
9
+
[role="_abstract"]
10
+
After installing {pac}, cluster administrators can configure a Git repository hosting service provider. Currently, the following services are supported:
11
+
12
+
* GitHub App
13
+
* GitHub Webhook
14
+
* GitLab
15
+
* Bitbucket Server
16
+
* Bitbucket Cloud
17
+
18
+
[NOTE]
19
+
====
20
+
GitHub App is the recommended service for using Pipelines as Code.
GitHub Apps act as a point of integration with {pipelines-title} and bring the advantage of Git-based workflows to OpenShift Pipelines. Cluster administrators can configure a single GitHub App for all cluster users. For GitHub Apps to work with Pipelines as Code, ensure that the webhook of the GitHub App points to the Pipelines as Code event listener route (or ingress endpoint) that listens for GitHub events.
@@ -40,6 +40,12 @@ To create and configure a GitHub App manually for {pac}, perform the following s
* **Webhook URL**: The {pac} route or ingress URL. You can find it by running the command `echo https://$(oc get route -n openshift-pipelines pipelines-as-code-controller -o jsonpath='{.spec.host}')`.
43
+
+
44
+
[NOTE]
45
+
====
46
+
If {pac} is installed without using the {pipelines-title} Operator, use the `pipelines-as-code` namespace instead of `openshift-pipelines`.
47
+
====
48
+
+
43
49
* **Webhook secret**: An arbitrary secret. You can generate a secret by executing the command `openssl rand -hex 20`.
44
50
45
51
. Select the following **Repository permissions**:
@@ -78,14 +84,15 @@ To configure {pac} to access the newly created GitHub App, execute the following
0 commit comments