Skip to content

Commit 123fbc8

Browse files
authored
Update gitlab-vcs-support.adoc
1 parent f589412 commit 123fbc8

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

jekyll/_cci2/gitlab-vcs-support.adoc

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Welcome to the GitLab VCS Support Preview
1919
2020
We are excited to offer a preview of GitLab VCS support. While we are proud of what we have built so far, we are iterating to improve known performance issues. At this time, we recommend not using GitLab for production of critical work.
2121
22-
Try it and tell us what you think. We would appreciate your feedback as we continue to iterate towards a seamless and stable experience.
22+
Try it and tell us what you think. We would appreciate your feedback as we continue to iterate towards a seamless and stable experience.
2323
2424
https://ideas.circleci.com/gitlab-vcs-experience-feedback[Give feedback]
2525
====
@@ -35,7 +35,7 @@ GitLab support preview is open to both new and existing users of CircleCI. See t
3535

3636
. https://circleci.com/signup/[Sign up for CircleCI] using the **Sign up with Email** option (you will also create a password).
3737

38-
. After you set an email and password, you will be taken to a screen with the option to connect GitLab, GitHub, or Bitbucket. Click **Connect** for GitLab.
38+
. After you set an email and password, you will be taken to a screen with the option to connect GitLab, GitHub, or Bitbucket. Click **Connect** for GitLab.
3939
+
4040
NOTE: If you choose to also connect your GitHub or Bitbucket accounts with your new account, your accounts will be merged based on the VCS account name that you used.
4141

@@ -48,7 +48,7 @@ After you successfully create a new organization, you will be taken to the web a
4848
[#current-circleci-users-create-a-new-organization]
4949
=== Current CircleCI users: Create a new organization
5050

51-
. Log in to the https://app.circleci.com/[CircleCI web app].
51+
. Log in to the https://app.circleci.com/[CircleCI web app].
5252

5353
. Click on your organization name to open the organization switcher on the top left. Select **Create New Organization**.
5454

@@ -65,19 +65,19 @@ NOTE: Existing CircleCI users can also opt to sign up via email and password. If
6565
[#step-two-create-new-project]
6666
== Step two - Create a new project
6767

68-
You will need API access and write permissions on the repository you want to set up. Within GitLab, this is the “maintainer” role or higher.
68+
You will need API access and write permissions on the repository you want to set up. Within GitLab, this is the “maintainer” role or higher.
6969

7070
If you use an access token as described in the steps below, you need to select the `api` and `write_permissions` scopes.
7171

72-
. In the CircleCI web app, navigate to **Projects**, then click the **Create Project** button.
72+
. In the CircleCI web app, navigate to **Projects**, then click the **Create Project** button.
7373

74-
. Enter a name for your project.
74+
. Enter a name for your project.
7575

76-
. Under **Code Source**, you have the option to connect to GitLab via **OAuth**, or using an **access token**. You must choose one.
76+
. Under **Code Source**, you have the option to connect to GitLab via **OAuth**, or using an **access token**. You must choose one.
7777
+
7878
NOTE: At this time, GitLab users on the Free tier should only use personal access tokens when setting up projects in CircleCI. See <<#gitlab-oauth-for-free-plans,Known issues>> below for more details.
7979
+
80-
**To connect to GitLab via OAuth:** click the **Connect** button. A browser window will open and direct you to GitLab's sign-in page. Once you have authenticated in GitLab, you will be redirected back to the Create New Project window in CircleCI.
80+
**To connect to GitLab via OAuth:** click the **Connect** button. A browser window will open and direct you to GitLab's sign-in page. Once you have authenticated in GitLab, you will be redirected back to the Create New Project window in CircleCI.
8181
+
8282
NOTE: It may take a second OAuth attempt to successfully connnect.
8383
+
@@ -93,14 +93,14 @@ image::{{site.baseurl}}/assets/img/docs/gl-preview/gitlab-preview-connect-token.
9393
+
9494
. Select the repository you wish to set up, then click **Create Project**.
9595

96-
Behind the scenes, CircleCI is registering a webhook within your GitLab repository. You may verify this once you have successfully created the project by navigating to your repository's Settings > Webhooks page.
96+
Behind the scenes, CircleCI is registering a webhook within your GitLab repository. You may verify this once you have successfully created the project by navigating to your repository's Settings > Webhooks page.
9797

9898
[#step-three-trigger-pipeline]
9999
== Step three - Trigger a project pipeline in CircleCI
100100

101-
At this time, setting up a new GitLab project does not automatically trigger a pipeline. Adding or editing a CircleCI configuration within the CircleCI web app is also not currently available.
101+
At this time, setting up a new GitLab project does not automatically trigger a pipeline. Adding or editing a CircleCI configuration within the CircleCI web app is also not currently available.
102102

103-
. If you have not already done so, create a `.circleci` directory at the root of your GitLab repository, and add a `config.yml` file in that directory.
103+
. If you have not already done so, create a `.circleci` directory at the root of your GitLab repository, and add a `config.yml` file in that directory.
104104
+
105105
NOTE: If you are new to CircleCI, you may wish to get started with our <<hello-world#echo-hello-world-on-linux#,Hello World>> example, or take a look at some of our <<sample-config#,sample configurations>>. The <<configuration-reference#,Configuring CircleCI>> document is a full reference to the keys used in a `.circleci/config.yml` file.
106106

@@ -111,11 +111,11 @@ image::{{site.baseurl}}/assets/img/docs/gl-preview/gitlab-preview-successful-pip
111111
[#project-settings]
112112
== Project settings
113113

114-
Unlike GitHub or Bitbucket projects, the GitLab support preview introduces the concept of "standalone" projects that are not specific to a VCS.
114+
Unlike GitHub or Bitbucket projects, the GitLab support preview introduces the concept of "standalone" projects that are not specific to a VCS.
115115

116-
A project can have one or more **configurations** which are pipeline definitions, including, but not limited to, a `.circleci/config.yml` file in your repo.
116+
A project can have one or more **configurations** which are pipeline definitions, including, but not limited to, a `.circleci/config.yml` file in your repo.
117117

118-
A project can have one or more **triggers**, which are events from a source of change, including, but not limited to, a VCS. A trigger determines which configuration it should use to start a pipeline.
118+
A project can have one or more **triggers**, which are events from a source of change, including, but not limited to, a VCS. A trigger determines which configuration it should use to start a pipeline.
119119

120120
The following settings are found by clicking the **Project Settings** button within your project. At this time, both configurations and triggers are limited to GitLab. To read more about other settings you can enable for your projects, refer to the <<settings#,Settings>> document.
121121

@@ -136,7 +136,7 @@ Add a trigger that specifies which configuration source starts a pipeline. If yo
136136

137137
image::{{site.baseurl}}/assets/img/docs/gl-preview/gitlab-preview-project-settings-triggers.png[Trigger setup page]
138138

139-
Triggers and trigger rules determine how CircleCI handles events from the source of change, in this case, GitLab.
139+
Triggers and trigger rules determine how CircleCI handles events from the source of change, in this case, GitLab.
140140

141141
When a trigger is created, CircleCI registers a webhook with GitLab. Push events from GitLab are sent to CircleCI. CircleCI then uses the event data to determine _if_ a pipeline should run, and if so, _which_ pipeline should be run.
142142

@@ -165,18 +165,18 @@ When creating a project, an SSH key is created which is used to checkout code fr
165165
[#organization-settings]
166166
== Organization settings
167167

168-
The GitLab preview also introduces the concept of "standalone" organizations, which are not tied to a VCS.
168+
The GitLab preview also introduces the concept of "standalone" organizations, which are not tied to a VCS.
169169

170-
A standalone organization allows for managing users and projects independent of the VCS. Organizations as well as users are considered CircleCI organizations and users, with their own roles and permissions that do not rely on those defined in a VCS.
170+
A standalone organization allows for managing users and projects independent of the VCS. Organizations as well as users are considered CircleCI organizations and users, with their own roles and permissions that do not rely on those defined in a VCS.
171171

172172
To manage settings on the organization level, click the **Organization Settings** button within the CircleCI web app. More general information on organization settings in CircleCI can be found in the <<settings#,Settings>> document.
173173

174174
[#organization-settings-people]
175175
=== People
176176

177-
Add or remove users, and manage user roles for the organization as well as user invites.
177+
Add or remove users, and manage user roles for the organization as well as user invites.
178178

179-
NOTE: You must have at least one org administrator. If you try to remove the last org administrator, you will get an error.
179+
NOTE: You must have at least one org administrator. If you try to remove the last org administrator, you will get an error.
180180

181181
[#inviting-your-first-team-members]
182182
==== Inviting your first team members
@@ -187,20 +187,20 @@ image::{{site.baseurl}}/assets/img/docs/gl-preview/gitlab-preview-org-settings-p
187187

188188
. Click the **Invite** button.
189189

190-
. Enter the email address of the user you wish to invite, and select the appropriate role. You may enter multiple addresses at once, if you wish to assign these users the same role.
190+
. Enter the email address of the user you wish to invite, and select the appropriate role. You may enter multiple addresses at once, if you wish to assign these users the same role.
191191
+
192192
Organization administrator as well as organization contributor roles are currently available. Project-specific roles will be coming soon. For more information on roles and permissions, refer to the <<#about-roles-and-permissions,next section>>.
193193

194194
. An invited user will receive an email notification (sent from `[email protected]`), containing a link to accept the invite.
195195
+
196-
If they do not currently have a CircleCI account, they will need to sign up. If they already have a CircleCI account, they are added to the organization, and if they are logged in, they will see the organization as an option in the organization switcher in the top left corner of the web app.
196+
If they do not currently have a CircleCI account, they will need to sign up. If they already have a CircleCI account, they are added to the organization, and if they are logged in, they will see the organization as an option in the organization switcher in the top left corner of the web app.
197197

198198
[#about-roles-and-permissions]
199199
==== About roles and permissions
200200

201201
CircleCI users have different abilities depending on assigned roles in a particular organization.
202202

203-
Your CircleCI user roles and permissions are not derived from your VCS permissions, and they do not allow you to bypass permissions in the VCS. For example, you may be an _Organization Administrator_ within CircleCI, which gives you access to view and modify organization and project settings _within your CircleCI organization_. However, you will not be able to edit a project’s `.circleci/config.yml` hosted in your VCS without your user also having the write permissions _within that VCS's repository project_. Your CircleCI user’s VCS permissions are determined by its associated GitLab identity.
203+
Your CircleCI user roles and permissions are not derived from your VCS permissions, and they do not allow you to bypass permissions in the VCS. For example, you may be an _Organization Administrator_ within CircleCI, which gives you access to view and modify organization and project settings _within your CircleCI organization_. However, you will not be able to edit a project’s `.circleci/config.yml` hosted in your VCS without your user also having the write permissions _within that VCS's repository project_. Your CircleCI user’s VCS permissions are determined by its associated GitLab identity.
204204

205205
Your GitLab identity can be managed through your CircleCI user profile’s account integrations, or the connection when managing triggers and configuration.
206206

@@ -353,17 +353,17 @@ Auto-cancel redundant workflows is not supported at this time. Refer to the <<sk
353353
[#restricted-access-to-contexts]
354354
=== Restricted access to contexts
355355

356-
Restricted access to contexts is not supported in the GitLab preview at this time. This means that any user within the organization can create triggers, and any users that can trigger pipelines from the source can use those contexts. In a future update, it will be possible to limit access to contexts by project and/or branch, giving your organization greater control and ensuring individual users only have access to the contexts they require.
356+
Restricted access to contexts is not supported in the GitLab preview at this time. This means that any user within the organization can create triggers, and any users that can trigger pipelines from the source can use those contexts. In a future update, it will be possible to limit access to contexts by project and/or branch, giving your organization greater control and ensuring individual users only have access to the contexts they require.
357357

358358
If you would like more information about using contexts within CircleCI, visit the <<contexts#,Using Contexts>> page.
359359

360360
[#project-roles]
361-
=== Project roles
361+
=== Project roles
362362

363363
Organizations can limit user access to a project or projects, and not require an organization-level role. This gives greater control over which users have access to projects across the organization, and limits access to organization settings or creating new projects.
364364

365365
[#account-integrations]
366-
=== Account integrations
366+
=== Account integrations
367367

368368
There is currently no method to manage GitLab integrations in this area. We are working on including GitLab in the options listed.
369369

@@ -375,50 +375,50 @@ NOTE: The following sections are features of CircleCI which are known issues in
375375
[#ssh-rerun-is-not-working]
376376
=== SSH rerun is not working
377377

378-
Support for SSH rerun is currently not available. This will be resolved in a future release.
378+
Support for SSH rerun is currently not available. This will be resolved in a future release.
379379

380380
[#additional-ssh-keys-only]
381381
=== Additional SSH keys only
382382

383-
Deploy Key and User Key are not being used at this time. All SSH keys generated for a project will be stored under **Additional SSH Keys**.
383+
Deploy Key and User Key are not being used at this time. All SSH keys generated for a project will be stored under **Additional SSH Keys**.
384384

385385
[#user-account-integrations-do-not-include-gitlab]
386-
=== User account integrations do not include GitLab
386+
=== User account integrations do not include GitLab
387387

388-
The **User Settings > Account Integrations** page does not currently include GitLab as a choice.
388+
The **User Settings > Account Integrations** page does not currently include GitLab as a choice.
389389

390390
At this time, GitLab integration should only be configured through new project creation. Project settings for creating triggers and configuration will be added soon.
391391

392392
[#advanced-options-in-project-settings]
393393
=== Advanced options in project settings
394394

395395
- **Auto-cancel redundant workflows** is not currently supported.
396-
- The **Free and Open Source** setting is not currently supported.
397-
- Project settings for building forked pull requests are not available.
396+
- The **Free and Open Source** setting is not currently supported.
397+
- Project settings for building forked pull requests are not available.
398398

399399
[#stop-building-option-in-project-settings]
400400
=== Stop building option in project settings
401401

402-
**Stop Building** does not work. The recommendation is to delete your webhooks in your GitLab repo if you no longer want a CircleCI pipeline to run.
402+
**Stop Building** does not work. The recommendation is to delete your webhooks in your GitLab repo if you no longer want a CircleCI pipeline to run.
403403

404404
[#plans-and-usage]
405405
=== Plans and usage
406406

407-
- Plans pages display the organization UUID and not the name.
408-
- Usage pages do not include the GitLab project name under **Projects**.
407+
- Plans pages display the organization UUID and not the name.
408+
- Usage pages do not include the GitLab project name under **Projects**.
409409
- Only users that created a project in CircleCI and triggered a build are counted as active users.
410410

411411
[#gitlab-oauth-for-free-plans]
412412
=== GitLab OAuth for Free plans
413413

414-
- The current CircleCI OAuth connection with GitLab is not successfully refreshing the token after the two hour expiration time. Users that are on a free GitLab plan will not be able to set up additional projects and builds will fail after the two hour expiry. We are working on resolving this issue. In the meantime, users with free GitLab plans should use a personal access token when setting up a new project.
415-
- For users on the free GitLab plan that have already set up GitLab projects with OAuth in CircleCI, we recommend revoking the CircleCI application from within GitLab until this issue is resolved.
414+
- The current CircleCI OAuth connection with GitLab is not successfully refreshing the token after the two hour expiration time. Users that are on a free GitLab plan will not be able to set up additional projects and builds will fail after the two hour expiry. We are working on resolving this issue. In the meantime, users with free GitLab plans should use a personal access token when setting up a new project.
415+
- For users on the free GitLab plan that have already set up GitLab projects with OAuth in CircleCI, we recommend revoking the CircleCI application from within GitLab until this issue is resolved.
416416
+
417417
. You can revoke the CircleCI application by navigating to your GitLab user account's Preferences > Applications.
418418
+
419419
. Next, delete your trigger and configuration from your CircleCI project via **Project Settings**.
420420
+
421-
. You can then manually add a new configuration and trigger using a personal access token. Note that the "GitLab X Token" is a secret and can be anything you want.
421+
. You can then manually add a new configuration and trigger using a personal access token. Note that the "GitLab X Token" is a secret and can be anything you want.
422422

423423

424424

0 commit comments

Comments
 (0)