Skip to content
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ Provide CircleCI with a GitHub user key in your project's **Project Settings** >
[#establish-the-authenticity-of-an-ssh-host]
== Establish the authenticity of an SSH host

When using SSH keys to check out a repository, it may be necessary to add the fingerprints for GitHub to a "known hosts" file (`~/.ssh/known_hosts`). Using `known_hosts` allows the executor can verify that the host it is connecting to is authentic. The xref:reference:ROOT:configuration-reference.adoc#checkout[`checkout` job step] does this automatically, so you will need to run the following commands if you opt to use a custom checkout command:
When using SSH keys to check out a repository, it may be necessary to add the fingerprints for GitHub to a "known hosts" file (`~/.ssh/known_hosts`). Using `known_hosts` allows the executor to verify that the host it is connecting to is authentic. The xref:reference:ROOT:configuration-reference.adoc#checkout[`checkout` job step] does this automatically, so you will need to run the following commands if you opt to use a custom checkout command:

```shell
mkdir -p ~/.ssh
Expand Down Expand Up @@ -331,7 +331,7 @@ If you would like to rename your organization or repository, follow the xref:sec
[#using-github-app-functionality]
== Using GitHub App functionality alongside the GitHub OAuth App

Some existing and future functionality on CircleCI can only be enabled through the more secure xref:github-apps-integration.adoc[CircleCI GitHub App integration].
Some existing and future functionality on CircleCI can only be enabled through the more secure CircleCI GitHub App integration. See the xref:permissions-authentication:users-organizations-and-integrations-guide.adoc[Users, organizations, and integrations guide] for more information.

Until October 2024, the CircleCI GitHub App integration was available exclusively to organizations created after September 2023. **Now, all organizations can install the CircleCI GitHub App to access new functionality. This includes organizations that currently integrate with CircleCI GitHub OAuth app.**

Expand Down
4 changes: 1 addition & 3 deletions docs/guides/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,7 @@
** xref:insights:insights-glossary.adoc[Insights glossary]

* Manage roles, permissions, and authentication
** xref:permissions-authentication:users-organizations-and-integrations-guide.adoc[Users, organizations, and integrations guide]
** Roles and permissions
*** xref:permissions-authentication:roles-and-permissions-overview.adoc[Roles and permissions overview]
*** xref:permissions-authentication:manage-roles-and-permissions.adoc[Manage roles and permissions]
Expand Down Expand Up @@ -270,12 +271,9 @@
*** xref:integration:notifications.adoc[Notifications]
** VCS integration
*** xref:integration:version-control-system-integration-overview.adoc[VCS integration overview]
*** xref:integration:github-apps-integration.adoc[GitHub App integration]
*** xref:integration:github-integration.adoc[GitHub OAuth app integration]
*** xref:guides:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth org]
*** xref:integration:gitlab-integration.adoc[GitLab integration]
*** xref:integration:bitbucket-data-center-integration.adoc[Bitbucket data center integration]
*** xref:integration:bitbucket-integration.adoc[Bitbucket Cloud integration]
*** xref:integration:oss.adoc[Build open source projects]

** Third-party integrations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ While splitting configuration files is only available for GitHub App integration
[#build-forked-prs-using-pipelines]
=== Can I trigger forked PRs using pipelines?

NOTE: The "build forked PRs" settings is not currently supported for GitLab or GitHub App projects. To find out if you authorized through the GitHub OAuth app or the CircleCI GitHub App, see the xref:guides:integration:github-apps-integration.adoc[GitHub App integration] page.
NOTE: The "build forked PRs" settings is not currently supported for GitLab or GitHub App pipelines. Check menu:Project Settings[Project setup] or menu:Project Settings[Pipelines] to see your pipeline type.

You can trigger pipelines to build PRs from forked repositories with CircleCI link:https://circleci.com/docs/api/v2/[API v2]. However, by default, CircleCI will not build a PR from a forked repository. If you would like to turn this feature on, navigate to menu:Project Settings[Advanced] in the web app. If you would like more information, you can view this link:https://support.circleci.com/hc/en-us/articles/360049841151-Trigger-pipelines-on-forked-pull-requests-with-CircleCI-API-v2[support article].
10 changes: 10 additions & 0 deletions docs/guides/modules/ROOT/partials/tips/check-org-type.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
****
To check your organization type, check your organization slug at menu:Organization settings[Overview]. `github` and `bitbucket` type organizations are OAuth authenticated orgs and the organization slug is structured as follows:

* `github/<your-org-name>` or `gh/<your-org-name>`
* `bitbucket/<your-org-name>` or `bb/<your-org-name>`

An organization slug for a `circleci` type organization is in the following format:

* `circleci/<UID>`
****
10 changes: 5 additions & 5 deletions docs/guides/modules/about-circleci/pages/concepts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -455,9 +455,9 @@ See the xref:orchestrate:pipelines.adoc[Pipelines overview] page for more inform
[#projects]
== Projects

For xref:integration:github-integration.adoc[GitHub OAuth app] and xref:integration:bitbucket-integration.adoc[Bitbucket Cloud] accounts, a _project_ in CircleCI is tied to, and shares the name of the associated code repository in your VCS.
For GitHub OAuth app and Bitbucket Cloud accounts, a _project_ in CircleCI is tied to, and shares the name of the associated code repository in your VCS.

For xref:integration:github-apps-integration.adoc[GitHub App], xref:integration:gitlab-integration.adoc[GitLab SaaS and self-managed] and xref:integration:bitbucket-data-center-integration.adoc[Bitbucket Data Center] users, a _project_ in CircleCI is standalone. You name your project and then connect your code (in your GitHub, GitLab or Bitbucket Data Center repository) to that project.
For GitHub App, GitLab SaaS and self-managed and Bitbucket Data Center users, a _project_ in CircleCI is standalone. You name your project and then connect your code (in your GitHub, GitLab or Bitbucket Data Center repository) to that project.

****
**Project names** must meet the following requirements:
Expand Down Expand Up @@ -541,12 +541,12 @@ See the xref:orchestrate:jobs-steps.adoc[Jobs and steps] page for more informati
[#user-types]
== User roles

CircleCI roles are set up differently depending on how you xref:integration:version-control-system-integration-overview.adoc[integrate your code].
CircleCI roles are set up differently depending on your xref:permissions-authentication:users-organizations-and-integrations-guide.adoc#organization-type[organization type].

TIP: To find out if you authorized through the GitHub OAuth app or the CircleCI GitHub App, see the xref:integration:github-apps-integration.adoc[GitHub App integration] page.
include::ROOT:partial$tips/check-org-type.adoc[]

=== GitHub App, GitLab and Bitbucket Data Center users
Roles are set at the organization and project level and are separate to permissions and roles set in the version control system in which your code is stored. The available roles are:
For `circleci` type organizations, roles are set at the organization and project level and are separate to permissions and roles set in the version control system in which your code is stored. The available roles are:

* Admin
* Contributor
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ Inside the application, you will find the features including the following:

This page is not an exhaustive guide to the web app, but is an introduction to some of the information, options, and settings available.

NOTE: Some settings and functionality described in on this page, including the in-app configuration editor, are currently not available for xref:integration:github-apps-integration.adoc[GitHub App], xref:integration:gitlab-integration.adoc[GitLab] and xref:integration:bitbucket-data-center-integration.adoc[Bitbucket Data Center] projects. For an overview of feature availability for each integration type, see the xref:integration:version-control-system-integration-overview.adoc[VCS integration overview] page.
Some settings and functionality described in on this page, including the in-app configuration editor, are currently not available for `circleci` type organizations. For an overview of feature availability for each organization/integration type, see the xref:integration:version-control-system-integration-overview.adoc[VCS integration overview] page.

include::ROOT:partial$tips/check-org-type.adoc[]

== User homepage

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/modules/deploy/pages/set-up-rollbacks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ image::guides:ROOT:deploy/project-overview-rollback.png[Rollback button on proje

=== 2. Confirm GitHub App installation

NOTE: To set up rollback pipelines, you must connect your organization to the xref:integration:github-apps-integration.adoc[CircleCI GitHub App].
NOTE: To set up rollback pipelines, you must install the CircleCI GitHub App into your organization. For more information, see the xref:permissions-authentication:users-organizations-and-integrations-guide.adoc#install-the-circleci-github-app[Users, organizations, and integrations guide].

- If the GitHub App is not installed in your organization, the guided setup process prompts you to install it.
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ Before setting up your environment integration with CircleCI, run through the fo
* A CircleCI account connected to your code. You can link:https://circleci.com/signup/[sign up for free].
* A Kubernetes cluster.
* A project building on CircleCI that deploys to your Kubernetes cluster. See the xref:getting-started:create-project.adoc[Create a project] page for steps.
* You must have write access to the project associated with the component being deployed. For full details of roles and permissions for GitLab and GitHub App integrations, see the xref:permissions-authentication:roles-and-permissions-overview.adoc[Roles and permissions overview]. If your integration is through Bitbucket or the GitHub OAuth app, you will need to be an org admin in Bitbucket/GitHub respectively. To find out which GitHub integration you have, see the xref:integration:github-apps-integration.adoc[GitHub App integration] page.
* You must have write access to the project associated with the component being deployed. For full details of roles and permissions for `circleci` type organizations see the xref:permissions-authentication:roles-and-permissions-overview.adoc[Roles and permissions overview]. If you have a `github` or `bitbucket` type organization, you will need to be an org admin in Bitbucket/GitHub respectively.

include::ROOT:partial$tips/check-org-type.adoc[]

The following versions of Kubernetes, Helm, and Argo Rollouts have been tested and proven to work. Older versions may work but are not guaranteed:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ NOTE: Using CircleCI server? Use the <<set-up-a-project>> steps below. Rather th
[#create-a-project]
=== Create a project

NOTE: If you have integrated your code with the xref:integration:github-apps-integration.adoc[CircleCI GitHub App], xref:integration:gitlab-integration.adoc[GitLab], or xref:integration:bitbucket-data-center-integration.adoc[Bitbucket Data Center], the steps in this section apply to you.
If you are using a `circleci` type organization, the steps in this section apply to you.

include::ROOT:partial$tips/check-org-type.adoc[]

Choose steps to follow below, depending on where your code is stored:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,7 @@ If you are signing up using an invite from your team, you will be _joining_ an e

NOTE: If you are setting up a project for the first time, you may need to authenticate with your VCS provider. Once you have completed a one-time authentication, you will be able to set up subsequent projects in CircleCI more quickly. Refer to the xref:create-project.adoc[Creating a Project] guide for more information.

Guides for integrating GitHub, Bitbucket, or GitLab projects are available as follows:

- xref:integration:github-apps-integration.adoc[GitHub App integration]
- xref:integration:github-integration.adoc[GitHub OAuth app integration]
- xref:integration:bitbucket-integration.adoc[Bitbucket Cloud integration]
- xref:integration:gitlab-integration.adoc[GitLab integration]
- xref:integration:bitbucket-data-center-integration.adoc[Bitbucket Data Center integration]
For a guide to integrating your code with CircleCI, see the xref:permissions-authentication:users-organizations-and-integrations-guide.adoc[Users, organizations, and integrations guide].

[#terms]
== Terms
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,13 @@ NOTE: If you do not see the organization you would like to join listed, you will

The steps in this section show how an org admin can invite teammates to join their organization.

include::ROOT:partial$tips/check-github-type-org.adoc[]
The steps are different depending on your organization type.

include::ROOT:partial$tips/check-org-type.adoc[]

[tabs]
====
GitHub App GitLab Bitbucket Data Center::
`circleci` type organization::
+
--
. In the CircleCI web app, select your org from the org cards on your user homepage.
Expand All @@ -67,7 +69,7 @@ GitHub App GitLab Bitbucket Data Center::

image::guides:ROOT:invite-teammates-standalone.png[Navigate to Organization Settings, People, use the Invite form]
--
GitHub OAuth Bitbucket Cloud::
`github` or `bitbucket` type organization::
+
--
. In the CircleCI web app, select your org from the org cards on your user homepage.
Expand Down
13 changes: 2 additions & 11 deletions docs/guides/modules/integration/pages/add-ssh-key.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
:page-description: How to add additional SSH keys to CircleCI
:experimental:

Add additional SSH keys to your project for access to deploy other services or to write to, or checkout code from other repositories.
Add additional SSH keys to your project for access to deploy to other services or to write to, or checkout code from other repositories.

If you want to set up an SSH key in order to checkout code from additional repositories in GitHub (xref:github-integration.adoc[GitHub OAuth app only]) or Bitbucket Cloud within a job, refer to the xref:github-integration.adoc#enable-your-project-to-check-out-additional-private-repositories[GitHub OAuth app] or xref:bitbucket-integration.adoc#enable-your-project-to-check-out-additional-private-repositories[Bitbucket Cloud] integration pages. If you need additional SSH keys to access other services and your org is set up to the use xref:github-integration.adoc[GitHub OAuth app] or Bitbucket Cloud, follow the steps below.

Expand Down Expand Up @@ -105,13 +105,4 @@ Example:
[source,bash]
----
ssh -i ~/.ssh/id_rsa_a3f982c51d479be68832a1bcf4297e15 -o "IdentitiesOnly=yes" user@hostname
----

[#see-also]
== See also

* xref:github-integration.adoc[GitHub OAuth app integration]
* xref:github-apps-integration.adoc[GitHub App integration]
* xref:bitbucket-integration.adoc[Bitbucket integration]
* xref:bitbucket-data-center-integration.adoc[Bitbucket Data Center integration]
* xref:gitlab-integration.adoc[GitLab integration]
----
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ Config orchestration tools are available from within your pipelines are as follo
=== Prerequisites

* A CircleCI account. You can sign up for free at link:https://circleci.com/signup/[circleci.com].
* Your CircleCI account must be linked to a GitHub account, either via xref:integration:github-integration.adoc[GitHub OAuth] or via the xref:integration:github-apps-integration.adoc[CircleCI GitHub App].
* Your CircleCI account must be linked to a GitHub account, either via GitHub OAuth or via the CircleCI GitHub App.
* A GitHub App pipeline that you want to trigger when a PR is opened. You can find steps on the xref:pipelines.adoc#add-or-edit-a-pipeline[Pipelines overview and setup] page.

=== Steps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Before following this how-to guide, ensure you have met the following prerequisi
* A CircleCI account, xref:getting-started:first-steps.adoc#[you can sign up for free].
* Familiarity with CircleCI configuration files. See the xref:getting-started:introduction-to-yaml-configurations.adoc[Introduction to YAML Configurations] guide for more information.
* Familiarity with the concepts of URL and registry orbs, and the URL orb allow-list. See the xref:orbs:use:orb-intro.adoc[Orbs intro] and the xref:orbs:use:managing-url-orbs-allow-lists.adoc[Managing URL orb allow-lists] guide for more information.
* xref:integration:github-apps-integration.adoc[GitHub App integration]. This is optional but recommended to get the best experience with centralized configs due to the ability to define pipelines in which the configuration files is stored outside the project repository.
* A GitHub App integration. This is optional but recommended to get the best experience with centralized configs due to the ability to define pipelines in which the configuration files is stored outside the project repository. See the xref:permissions-authentication:users-organizations-and-integrations-guide.adoc[Users, organizations, and integrations guide] for more information.

== Simple config override example

Expand Down Expand Up @@ -273,7 +273,7 @@ This allows importing configurations from any repository in your GitHub organiza
=== 4. Set up pipeline definitions
For each project using the centralized configuration the platform team needs to:

* Configure the project to use GitHub App integration. The CircleCI GitHub App integration is required to use a config source outside the project repo. See the xref:integration:github-apps-integration#[GitHub App integration] guide for more information.
* Ensure the organization has the CircleCI GitHub App installed. The CircleCI GitHub App integration is required to use a config source outside the project repo. See the xref:permissions-authentication:users-organizations-and-integrations-guide.adoc[Users, organizations, and integrations guide] for more information.
* Create a pipeline definition pointing to the central template configuration. This means setting up a pipeline in which the config source is outside the project repository. The config source will be the centralized, _template_ configuration managed by the platform team.

[#transitioning-to-centralized-configs]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For a full list, see the xref:github-trigger-event-options.adoc[GitHub trigger e

To use multiple pipelines and configs for a project in CircleCI, you will need to meet the following prerequisites:

* A CircleCI account connected to your code in GitHub. You can link:https://circleci.com/signup/[sign up for free]. Any of CircleCI's GitHub integrations are supported, read our link:https://discuss.circleci.com/t/product-update-using-github-app-functionality-in-a-github-oauth-app-organization/52204/1[community forum] for background on how this functionality can be used with an org integrated CircleCI's GitHub OAuth App. To use multiple pipelines for a project you will use the xref:integration:github-apps-integration.adoc[CircleCI GitHub App integration].
* A CircleCI account connected to your code in GitHub. You can link:https://circleci.com/signup/[sign up for free]. Using GitHub you can integrate your code through the CircleCI GitHub App or the GitHub OAuth app. See the xref:permissions-authentication:users-organizations-and-integrations-guide.adoc[Users, organizations, and integrations guide] for more information.
* A project set up in CircleCI that you want to configure with multiple, distinct pipelines defined with different configuration files. See the xref:getting-started:create-project.adoc[Create a project in CircleCI] page for steps to get your project set up in CircleCI.

[#add-additional-config-file]
Expand Down
Loading