From 9d77e96e33cf5e312db3704cf853d4d65b06f31d Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Mon, 13 Jul 2026 12:52:07 +0000 Subject: [PATCH 1/2] Add GitLab tab to 'How CircleCI checks out your code' section - Added GitLab tab explaining SSH key creation and usage - Documented how SSH keys are used for checkout operations - Included reference to GitLab self-managed SSH host key setup - Resolves DOC-16 Co-authored-by: Rosie Yohannan --- ...users-organizations-and-integrations-guide.adoc | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/guides/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc b/docs/guides/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc index 11204d3ce1..ff75bd6d62 100644 --- a/docs/guides/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc +++ b/docs/guides/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc @@ -579,6 +579,20 @@ Bitbucket Data Center:: -- When you connect a repository with your CircleCI project, behind the scenes, CircleCI is registering a webhook within your Bitbucket Data Center project. You may verify this once you have successfully created the project by navigating to your repository's menu:Project Settings[Webhooks] page. -- +GitLab:: ++ +-- +When you create a GitLab-based project in CircleCI, an SSH key is created, which is used to check out code from your repository. Each pipeline configuration you create generates a new SSH key to access the code in the repository associated with that configuration. + +The private key is installed into the `.ssh` directory when CircleCI builds your project, and SSH is configured to communicate with GitLab. Therefore, the SSH key is used for: + +- Checking out the main project. +- Checking out any GitLab-hosted submodules. +- Checking out any GitLab-hosted private dependencies. +- Automatic git merging/tagging/etc. + +For GitLab self-managed instances, you will need to provide SSH host keys during the integration setup. You can retrieve these keys by running `ssh-keyscan `. See the <> section for more information on configuring GitLab self-managed integrations. +-- ==== === Custom checkout commands From 80e9a282176aab1463c18d9f012f820f5b05d6b8 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Mon, 13 Jul 2026 13:18:18 +0000 Subject: [PATCH 2/2] Fix GitLab SSH key creation description - Changed from 'per configuration' to 'per project' to match GitHub and Bitbucket tabs - Removed inaccurate statement about multiple SSH keys per configuration - Made language consistent with other VCS provider tabs Co-authored-by: Rosie Yohannan --- .../pages/users-organizations-and-integrations-guide.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc b/docs/guides/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc index ff75bd6d62..6ba554a57f 100644 --- a/docs/guides/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc +++ b/docs/guides/modules/permissions-authentication/pages/users-organizations-and-integrations-guide.adoc @@ -582,9 +582,9 @@ When you connect a repository with your CircleCI project, behind the scenes, Cir GitLab:: + -- -When you create a GitLab-based project in CircleCI, an SSH key is created, which is used to check out code from your repository. Each pipeline configuration you create generates a new SSH key to access the code in the repository associated with that configuration. +When you set up a new project with GitLab in CircleCI, an SSH key is created, which is used to check out code from your repository. -The private key is installed into the `.ssh` directory when CircleCI builds your project, and SSH is configured to communicate with GitLab. Therefore, the SSH key is used for: +When CircleCI builds your project, the private key is installed into the `.ssh` directory and SSH is configured to communicate with GitLab. Therefore, the SSH key is used for: - Checking out the main project. - Checking out any GitLab-hosted submodules.