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
Copy file name to clipboardExpand all lines: jekyll/_cci2/github-trigger-event-options.adoc
+21-5Lines changed: 21 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -14,23 +14,39 @@ When you create a trigger for a GitHub App pipeline, you can choose from a set o
14
14
15
15
== Introduction
16
16
17
-
When you set up a project in CircleCI you will also set up your first pipeline and trigger. This first trigger is, by default, an "all push" trigger, which corresponds to the link:https://docs.github.com/en/webhooks/webhook-events-and-payloads#push[GitHub App push event]. If you have a GitHub App account with CircleCI, you will see trigger options when creating a project in the CircleCI web app, and you have the option to change the trigger options for your first trigger. You can also set up additional triggers during project creation, or setup/edit later in your menu:Project settings[Triggers].
17
+
CircleCI projects have pipelines and trigger.
18
18
19
-
.Trigger options during project creation
20
-
image::triggers/create-project-run-on.png[Create a project trigger and access trigger options]
19
+
* Pipelines define the various CI/CD 'units' of work that make up your project.
20
+
* Triggers define when and how to initiate a pipeline.
21
+
22
+
Configure triggers under menu:Project settings[Triggers]. You can configure triggers to initiate pipelines on a variety of events. This page focuses on events from GitHub, but you can find the full list of events that can trigger a pipeline on the xref:triggers-overview#[Trigger a pipeline] page.
21
23
22
-
Once your project is set up you can create additional pipelines and triggers (menu:Project settings[Triggers]). You can configure your triggers to initiate pipelines on a variety of events, including non-push events, for example, a pull request being opened, or refined push events, for example, only pushes to a default branch, or pushes to a tag. For a full list see <<supported-trigger-options>>.
24
+
For a full list of GitHub trigger event options, see <<supported-trigger-options>>.
23
25
24
26
.Trigger options under Project settings
25
27
image::triggers/run-on-open.png[Set a trigger option for a project trigger]
26
28
29
+
When you create or set up a project in CircleCI you will set up your first pipeline and trigger. This first trigger is, by default, an "all push" trigger, which corresponds to the link:https://docs.github.com/en/webhooks/webhook-events-and-payloads#push[GitHub App push event].
If your CircleCI organization is integrated with GitHub only through the **GitHub App** (see tip above), you will see trigger options when creating a project in the CircleCI web app, and you have the option to change the trigger options for your first trigger. You can also set up additional triggers during project creation, or setup/edit later in your menu:Project settings[Triggers].
34
+
35
+
.Trigger options during project creation
36
+
image::triggers/create-project-run-on.png[Create a project trigger and access trigger options]
37
+
38
+
If your CircleCI org is integrated via **GitHub OAuth** (see tip above), an org admin can install the CircleCI GitHub App to enable the full range of GitHub trigger events, as well as all other functionality enabled by the GitHub App. Installing the CircleCI GitHub App is a one-time action. For more information, see the xref:github-integration#installing-github-app-alongside-github-oauth-app[GitHub OAuth integration overview].
39
+
27
40
== Supported trigger options
28
41
29
42
[NOTE]
30
43
====
31
-
Regardless of your chosen trigger option, CircleCI will never trigger a pipeline for the following:
44
+
Regardless of your chosen trigger option, CircleCI will **never** trigger a pipeline for the following:
32
45
33
46
* On branch or tag deletion push events.
47
+
48
+
GitHub App pipelines are also never triggered on the following:
49
+
34
50
* When a new branch is created if there are no new commits on the branch.
0 commit comments