Skip to content

Commit a46a54b

Browse files
authored
Update GitHub App integration overview (#9208)
* Documenting support for 'Only build PR' options * Adding content for new GH App trigger options * Fixing Vale linting errors * Implementing suggestions * Fixing incorrect xref * Modifying as per review suggestions
1 parent e8ad342 commit a46a54b

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

jekyll/_cci2/github-apps-integration.adoc

+13-11
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,10 @@ When you create a new organization, you will be guided to start creating project
3232

3333
. The first project you create will prompt you to install the CircleCI GitHub App in a GitHub organization.
3434
. 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.
3739

3840
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.
3941

@@ -48,11 +50,9 @@ image::github-app-configuration-page.png[Create a project]
4850
[#trigger-pipeline]
4951
== Trigger a pipeline in CircleCI
5052

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.
5254

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.
5656

5757
image::{{site.baseurl}}/assets/img/docs/gl-ga/gitlab-ga-successful-pipeline.png[Successful pipeline run]
5858

@@ -97,6 +97,13 @@ You can add or delete pipelines for your project. For details see the xref:pipel
9797

9898
- You can enable dynamic configuration using setup workflows in CircleCI. To learn about dynamic configuration, read the xref:dynamic-config#[Dynamic configuration] guide.
9999

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+
100107
[#organization-settings]
101108
== Organization settings
102109

@@ -221,11 +228,6 @@ Deploy keys and user keys are not used by GitHub App integrations. All keys are
221228

222229
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.
223230

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.
228-
229231
[#next-steps]
230232
== Next steps
231233
- xref:config-intro#[Configuration tutorial]

0 commit comments

Comments
 (0)