Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
6e119bb
start new consolidated page
rosieyohannan Oct 20, 2025
9e9e4a4
add new page to nav
rosieyohannan Oct 20, 2025
75772ff
more work on a consolidated page
rosieyohannan Oct 22, 2025
72ab3c4
more work on bringing integration content together
rosieyohannan Oct 22, 2025
e30f9fe
bringing in more content to consolidated page
rosieyohannan Oct 23, 2025
dbba56b
more consolidation
rosieyohannan Oct 24, 2025
2b03cc7
bring across some more integraiton content and add user settings
rosieyohannan Nov 5, 2025
ca795f4
update links to integration page and archive github and bitbucket int…
rosieyohannan Nov 6, 2025
58e284a
remove incorrectly placed alias
rosieyohannan Nov 6, 2025
3aca1b0
Merge branch 'main' into DOCSS-1889-consolidate-integration-guides
rosieyohannan Nov 6, 2025
2a75973
add a page to create an organization
rosieyohannan Nov 12, 2025
8bc0edb
add tabs for additional ssh keys
rosieyohannan Nov 13, 2025
99f8e22
Merge branch 'main' into DOCSS-1889-consolidate-integration-guides
rosieyohannan Nov 13, 2025
0f89506
work on integration guide for GitLab self-managed and bbdc
rosieyohannan Nov 14, 2025
e051014
Merge branch 'main' into DOCSS-1889-consolidate-integration-guides
rosieyohannan Nov 14, 2025
dedee04
fix table scroll and archive gitlab integration page
rosieyohannan Nov 14, 2025
db70de9
some minor fixes
rosieyohannan Nov 17, 2025
c84892e
add section for ebable project to checkout repos section
rosieyohannan Nov 17, 2025
8c68399
fix links
rosieyohannan Nov 17, 2025
f527894
fix links again
rosieyohannan Nov 17, 2025
65ffb9f
streamline integration instructions for self-hosted VCS
rosieyohannan Nov 18, 2025
54b5af6
archive bbdc integraiton guides
rosieyohannan Nov 18, 2025
acb7956
fix link
rosieyohannan Nov 18, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
7 changes: 2 additions & 5 deletions docs/guides/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
*** xref:getting-started:language-javascript.adoc[Node.js quickstart]
*** xref:getting-started:language-python.adoc[Python quickstart]
*** xref:getting-started:language-go.adoc[Go quickstart]
*** xref:getting-started:create-an-organization.adoc[Create an organization]
** Tutorials
*** xref:getting-started:config-intro.adoc[Configuration intro]
*** xref:getting-started:slack-orb-tutorial.adoc[Use the Slack orb to set up notifications]
Expand Down Expand Up @@ -217,6 +218,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 +272,7 @@
*** 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 @@ -16,7 +16,7 @@ For GitHub users, your account has the "Owner" role in your GitHub organization.

For Bitbucket Cloud users, your account has "Admin" permissions in your Bitbucket repository.

For GitLab users, your account is listed as "Org Admin" in the CircleCI web app under xref:guides:integration:gitlab-integration.adoc#organization-settings-people[**Organization Settings > People**].
For GitLab users, your account is listed as "Org Admin" in the CircleCI web app under menu:Organization Settings[People].

[#what-happens-upon-cancelling-a-performance-plan-subscription]
=== What happens upon cancelling a Performance Plan subscription?
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 @@ -466,9 +466,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 @@ -552,12 +552,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#organizations[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
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ workflows:
only: main # Only deploys when the commit is on the `main` branch
```

If pushing to your repository is required, see the "Deployment Keys" section of the xref:integration:github-integration.adoc#deploy-keys-and-user-keys[GitHub] or xref:integration:bitbucket-integration.adoc#deploy-keys-and-user-keys[Bitbucket Cloud] instructions. Then, configure the Azure Web App to use your production branch.
If pushing to your repository is required, see the xref:permissions-authentication:users-organizations-and-integrations-guide.adoc#enable-project-to-check-out-additional-private-repositories[Users, Organizations, and Integrations Guide]. Then, configure the Azure Web App to use your production branch.
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 @@ -59,7 +59,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#integration-options[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
@@ -0,0 +1,51 @@
= Create an organization
:page-platform: Cloud
:page-description: Create a new organization in CircleCI.
:experimental:

This guide coverts creating a new organization in CircleCI.

The following organization types are available in CircleCI:

* `circleci` organizations
* `github` organizations
* `bitbucket` organizations

== Create a `circleci` organization

To create a `circleci` organization, follow these steps:

. Navigate to your user homepage in the link:https://app.circleci.com/home/[CircleCI web app].
. Select the btn:[+ Create organization] button.
. Give your organization a name and select btn:[Let's Go].

Once your new organization is created you can start creating projects and inviting team members:

* xref:create-project.adoc#create-a-project[Create a project]
* xref:invite-your-team.adoc#invite-teammates[Invite your team]

== Create a `github` organization

A `github` organization is created when you log in to CircleCI using your _social_ GitHub login. `github` organizations use an OAuth app connection with CircleCI. If you have logged in to CircleCI using a method other than your GitHub login, you can still create a `github` organization by following these steps:

. Navigate to your link:https://app.circleci.com/settings/user[User settings] page.
. Select the **Account Integrations** from the sidebar.
. At the bottom of the page, select the link that reads `Recieved instructions from the CircleCI Support team to authorize a GitHub OAuth app?`
. Follow the instructions to create a `github` organization.

Once your `github` organization is created you can start setting up and following projects:

* xref:create-project.adoc#set-up-a-project[Set up a project]

== Create a `bitbucket` organization

A `bitbucket` organization is created when you log in to CircleCI using your _social_ Bitbucket login. `bitbucket` organizations use an OAuth app connection with CircleCI. If you have logged in to CircleCI using a method other than your Bitbucket login, you can still create a `bitbucket` organization by following these steps:

. Navigate to your link:https://app.circleci.com/settings/user[User settings] page.
. Select the **Account Integrations** from the sidebar.
. Select btn:[Connect] next to Bitbucket.
. Follow the instructions to authorize the Bitbucket OAuth app.

Once your `bitbucket` organization is created you can start setting up and following projects:

* xref:create-project.adoc#set-up-a-project[Set up a project]
Loading