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: docs/guides/modules/integration/pages/github-apps-integration.adoc
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,8 @@
6
6
If your CircleCI organization is integrated with GitHub through the **CircleCI GitHub App**, the content on this page is for you.
7
7
8
8
****
9
-
The **CircleCI GitHub App** is an add-on integration, and all organizations that have `/github/` or `/circleci/` in the URL can install it - including xref:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[if they are already integrated through the GitHub OAuth app].
10
-
To check whether you organization has the CircleCI GitHub App installed, navigate to menu:Organization Settings[VCS Connections].
9
+
The **CircleCI GitHub App** is an add-on integration. All organizations that have `/github/` or `/circleci/` in the URL can install the GitHub App, including xref:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[those already integrated through the GitHub OAuth app].
10
+
To check whether you organization has the CircleCI GitHub App installed, navigate to menu:Organization Settings[VCS Connections].
11
11
****
12
12
13
13
This page walks you through integrating a GitHub project with CircleCI through the CircleCI GitHub App integration. The sections below introduce you to concepts and ways to manage CI/CD (continuous integration and continuous delivery) pipelines for your GitHub project. CircleCI features that are in development for GitHub App projects are detailed in the <<currently-not-supported>> section.
@@ -32,7 +32,7 @@ NOTE: If you are new to CircleCI, you may wish to get started with our xref:gett
32
32
33
33
A GitHub org with the CircleCI GitHub App installed can only be integrated with one CircleCI organization.
34
34
35
-
If you attempt to integrate a GitHub org with the CircleCI GitHub App installed with a second CircleCI organization, you will find yourself on a GitHub App integration settings page when attempting to create a project. If you are not sure what other CircleCI organization may be connected to your GitHub organization, you can submit a request link:https://forms.gle/dvcXN8ArByXqNNbJ7[here].
35
+
In this scenario, attempting to integrate with a second CircleCI organizationwill redirect you to a GitHub App integration settings page when creating a project. If you are not sure what other CircleCI organization may be connected to your GitHub organization, you can submit a request link:https://forms.gle/dvcXN8ArByXqNNbJ7[here].
36
36
37
37
image::guides:ROOT:github-app-configuration-page.png[Create a project]
38
38
@@ -119,13 +119,16 @@ A subset of built-in environment variables are not available in GitHub-based pro
119
119
120
120
Before attempting to move your information from an org integrated with the GitHub OAuth app to an org integrated with CircleCI’s GitHub App, consider the following:
121
121
122
-
* If the motivation for moving is to **leverage new functionality that is only available to the GitHub App integration**, consider using your existing organization and installing the GitHub App alongside your OAuth app integration, as described in xref:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[this guide].
122
+
* If the motivation for moving is to **leverage new functionality that is only available to the GitHub App integration**, consider using your existing organization and installing the GitHub App alongside your OAuth app integration, as described in xref:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[this guide].
123
123
* If the motivation is to **completely remove the OAuth app integration** for security, compliance, or other reasons, follow the steps below.
=== Steps to migrate to an organization without default GitHub OAuth integration
127
127
128
-
The following steps will guide you through migrating from an organization integrated with GitHub through the OAuth integration by default (identifyable by `/github/` or `/gh/` in the URL) to an organization that does not have a default OAuth integration with GitHub (identifyable by `/circleci/` in the URL).
128
+
The following steps guide you through migrating you organization as follows:
129
+
130
+
* *From* an organization integrated with GitHub through the OAuth integration by default (identifiable by `/github/` or `/gh/` in the URL).
131
+
* *To* an organization that does not have a default OAuth integration with GitHub (identifiable by `/circleci/` in the URL).
129
132
130
133
[CAUTION]
131
134
====
@@ -179,7 +182,7 @@ The in-app config editor is currently **only** available for GitHub App accounts
179
182
[#account-integrations]
180
183
=== Account integrations
181
184
182
-
Viewing menu:User settings[Account integrations] does not currently show a GitHub App integration. This page only shows GitHub Oauth app integrations.
185
+
Viewing menu:User settings[Account integrations] does not currently show a GitHub App integration. This page only shows GitHub OAuth app integrations.
0 commit comments