Setting up the Integration

Preconfigure your Organization

Ensure that the VPC admin preconfigured the organization of the Git provider with Code Ocean.

Configure Personal Access Token for Code Ocean

In order to establish the API call and complete the integration, follow the steps. Note that it might depend on the Git provider, the objective is to retrieve the token on the Git provider and add the token to your Code Ocean account.

Generate a personal access token (PAT) in your Git provider's account.

GitHub

Creating a token

1. In the upper-right corner of the page, click your profile photo, then click Settings.

2. In the left sidebar, click Developer settings.

3. In the left sidebar, click Personal access tokens.

4. Click Generate new token.

5. Fill out the form and check the repo box for the scope.

For more information about how to generate a PAT, read this article from GitHub.

GitLab

Create a personal access token

You can create as many personal access tokens as required.

1. In the top-right corner, select your avatar.

2. Select Edit profile.

3. On the left sidebar, select Access Tokens.

4. Enter a name and optional expiry date for the token.

5. Select the desired scopes.

6. Select Create personal access token.

There is the link to GitLab's documentation on getting the GitLab's PAT token.

Bitbucket

There is the link to Bitbucket's documentation on getting the Bitbucket's PAT token.

Save the PAT in Code Ocean under your account page.

1. Click the Account icon

2. From the Credentials screen click +Add Credentials

3. Click <Git provider> Credentials

4. Enter your Git provider's username and PAT.