Skip to content

Commit

Permalink
docs(core): add new Gitlab integration setup guide (#13969)
Browse files Browse the repository at this point in the history
  • Loading branch information
StalkAltan committed Dec 29, 2022
1 parent 2beb0e2 commit 7bbacea
Show file tree
Hide file tree
Showing 8 changed files with 74 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/generated/manifests/cloud.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,16 @@
"isExternal": false,
"path": "/nx-cloud/set-up/github",
"tags": []
},
{
"id": "gitlab",
"name": "Enable GitLab MR Integration",
"description": "",
"file": "nx-cloud/set-up/gitlab",
"itemList": [],
"isExternal": false,
"path": "/nx-cloud/set-up/gitlab",
"tags": []
}
],
"isExternal": false,
Expand All @@ -81,6 +91,16 @@
"path": "/nx-cloud/set-up/github",
"tags": []
},
"/nx-cloud/set-up/gitlab": {
"id": "gitlab",
"name": "Enable GitLab MR Integration",
"description": "",
"file": "nx-cloud/set-up/gitlab",
"itemList": [],
"isExternal": false,
"path": "/nx-cloud/set-up/gitlab",
"tags": []
},
"/nx-cloud/account": {
"id": "account",
"name": "Account Management",
Expand Down
16 changes: 16 additions & 0 deletions docs/generated/manifests/menus.json
Original file line number Diff line number Diff line change
Expand Up @@ -2987,6 +2987,14 @@
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Enable GitLab MR Integration",
"path": "/nx-cloud/set-up/gitlab",
"id": "gitlab",
"isExternal": false,
"children": [],
"disableCollapsible": false
}
],
"disableCollapsible": false
Expand All @@ -3007,6 +3015,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Enable GitLab MR Integration",
"path": "/nx-cloud/set-up/gitlab",
"id": "gitlab",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Account Management",
"path": "/nx-cloud/account",
Expand Down
5 changes: 5 additions & 0 deletions docs/map.json
Original file line number Diff line number Diff line change
Expand Up @@ -1201,6 +1201,11 @@
"name": "Enable GitHub PR Integration",
"id": "github",
"file": "nx-cloud/set-up/github"
},
{
"name": "Enable GitLab MR Integration",
"id": "gitlab",
"file": "nx-cloud/set-up/gitlab"
}
]
},
Expand Down
Binary file added docs/nx-cloud/set-up/add-gitlab-repository.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions docs/nx-cloud/set-up/gitlab.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Enable GitLab Integration

## Get Started

The Nx Cloud GitLab Integration lets you access the result of every run—with all its logs and build insights—straight from your Merge Requests.

## Connecting Your Workspace

![Access VCS Setup](/nx-cloud/set-up/access-vcs-setup.png)

Once on the VCS Integrations setup page, select "GitLab" in the platforms dropdown. You will be prompted to enter the name of your repository.

![Add GitLab Repository](/nx-cloud/set-up/add-gitlab-repository.png)

### Configuring Authentication

#### Using a Personal Access Token

To use a Personal Access Token for authentication, one must be generated with proper permissions. The minimum required permissions are shown in the screenshot below.

![Minimum GitLab Personal Access Token Permissions](/nx-cloud/set-up/minimal-gitlab-access-token.png)

Once this token is created, select the radio button for providing a personal access token, paste the value, and then click "Test Connection".

![Use PAT for Authentication](/nx-cloud/set-up/use-gitlab-pat-auth.png)

This will verify that Nx Cloud can connect to your repo. Upon a successful test, your configuration is saved, and setup is complete.

### Advanced Configuration

If your company runs a self-hosted GitLab installation, you may need to override the default URL that Nx Cloud uses to connect to the GitLab API. To do so, check the box labeled "Override GitLab API URL" and enter the correct URL for your organization.

![Override GitLab API URL](/nx-cloud/set-up/override-gitlab-api-url.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nx-cloud/set-up/override-gitlab-api-url.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nx-cloud/set-up/use-gitlab-pat-auth.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 7bbacea

@vercel
Copy link

@vercel vercel bot commented on 7bbacea Dec 29, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nx-dev – ./

nx-dev-nrwl.vercel.app
nx-five.vercel.app
nx-dev-git-master-nrwl.vercel.app
nx.dev

Please sign in to comment.