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-apps-integration.adoc
+13-11
Original file line number
Diff line number
Diff line change
@@ -32,8 +32,10 @@ When you create a new organization, you will be guided to start creating project
32
32
33
33
. The first project you create will prompt you to install the CircleCI GitHub App in a GitHub organization.
34
34
. After installing the GitHub App, you will select a repository to use for your project's first pipeline.
35
-
. CircleCI will automatically generate a custom configuration file based on the programming languages and frameworks detected in your repository for this pipeline. If you already have a YAML configuration file on the default branch of the repository that you selected, CircleCI will use the configuration file that exists in the repository instead of generating a new one for your project's first pipeline.
36
-
. If CircleCI generated a custom configuration file for you, CircleCI will commit the generated configuration to a new branch (`circleci-project-setup`).
35
+
. CircleCI will automatically generate a custom configuration file based on the programming languages and frameworks detected in your repository for this pipeline. If you already have a YAML configuration file on the default branch of the repository that you selected, CircleCI will use the configuration file that exists in the repository instead of generating a new one for your project's first pipeline.
36
+
. You can then choose a trigger event option out of the dropdown list.
37
+
. Finally, you can review your setup.
38
+
. If CircleCI generated a custom configuration file for you, CircleCI will commit the generated configuration to a new branch (`circleci-project-setup`) when you click the btn:[Commit config and run] button.
37
39
38
40
NOTE: If you are new to CircleCI, you may wish to get started with our xref:getting-started#[Quickstart guide], our xref:hello-world#[Hello world] examples, or take a look at some of our xref:sample-config#[sample configurations] that demonstrate different types of workflows. The xref:configuration-reference#[Configuration reference] is a full reference to the keys used in a `.circleci/config.yml` file.
39
41
@@ -48,11 +50,9 @@ image::github-app-configuration-page.png[Create a project]
48
50
[#trigger-pipeline]
49
51
== Trigger a pipeline in CircleCI
50
52
51
-
When you choose btn:[Commit and Run], as described above, a pipeline is triggered. You will see the pipeline running when you are taken to the CircleCI dashboard.
53
+
When you click btn:[Commit config and run], as described above, a pipeline is triggered. You will see the pipeline running when you are taken to the CircleCI dashboard.
52
54
53
-
If you choose to review the configuration file in the config editor first, the pipeline is triggered after you save the `.circleci/config.yml` by clicking the btn:[Commit and Run] button.
54
-
55
-
Each time you push changes to your GitHub repository, a new pipeline is triggered. You will see the pipeline running in the CircleCI web app.
55
+
When the event you selected under the "Run on" menu occurs (see the xref:github-app-trigger-options/#supported-trigger-options[GitHub event trigger options] page, for a full list of options), a new pipeline is triggered. You will see the pipeline running in the CircleCI web app.
@@ -97,6 +97,13 @@ You can add or delete pipelines for your project. For details see the xref:pipel
97
97
98
98
- You can enable dynamic configuration using setup workflows in CircleCI. To learn about dynamic configuration, read the xref:dynamic-config#[Dynamic configuration] guide.
99
99
100
+
[#only-build-pull-requests]
101
+
=== Only build pull requests
102
+
103
+
In your trigger settings, select the "PR opened or pushed to, default branch pushes, tag pushes" option under the "Run on" menu. For a full list of GitHub event trigger options, see the xref:github-app-trigger-options/#supported-trigger-options[GitHub event trigger options] page.
104
+
105
+
image::triggers/run-on-open.png[Run on trigger menu options]
106
+
100
107
[#organization-settings]
101
108
== Organization settings
102
109
@@ -221,11 +228,6 @@ Deploy keys and user keys are not used by GitHub App integrations. All keys are
221
228
222
229
xref:insights-tests#[Test Insights] is currently not supported for orgs authenticated with the CircleCI GitHub App. Test Insights is available for GitHub OAuth authenticated orgs that have GitHub App pipelines set up.
223
230
224
-
[#only-build-pull-requests]
225
-
=== Only build pull requests
226
-
227
-
The Only Build Pull Requests option (usually available in menu:Project Settings[Advanced] or within trigger setup options) is not currently supported for GitHub App integrations.
0 commit comments