Last updated

Add remote files from GitLab

If your project files are stored in a remote repository on GitLab, you can connect that repository, so you can access and publish those files in Redocly.

To connect a GitLab repo:

  1. Create new access token in GitLab.
  2. Create a new branch in Redocly.
  3. Enter the connection details in Redocly.
  4. Merge open pull request in Redocly.

Create a new access token in GitLab

Before you enter the connection details in Redocly, you need to create and copy a new access token for your account in GitLab. Redocly uses this access token to establish a connection to your repository. GitLab offers multiple types of access tokens. The access token you use needs to have api scope and at least Maintainer role.

See the GitLab documentation for creating the following access token types with the API scope option:

Create a new branch in Redocly

Before you make any changes to your project, you should create a new branch. This new branch is a place where you can make changes without affecting the published site until you are ready. After you have iterated on your changes based on reviews by your team and the updates have been approved, you can merge your changes into the published site.

To create a new branch:

  1. Go to the project editor.

  2. Click the name of the current branch.

    Screenshot where current branch is on project page

  3. Enter the name for your new branch and select Create Branch.

Enter the connection details in Redocly

  1. In the file tree, select the folder (or click on the empty space to select the root directory) where you want to add the remote content folder.
  2. Select + > New remote folder > Add Git repository.
  3. Enter a name for the new remote content folder and press Enter or Return key.
  4. Select GitLab.
  5. Enter a Connection name that identifies this GitLab connection.
  6. Enter the Access token you saved from the Create a new access token in GitLab step and select Next.
  7. Select the Namespace > Project > Branch.
  8. (Optional) Select the Folder, if you want to include only a specific folder from the repository.
  9. Select the Auto-sync or Auto-merge toggles to turn off either option.
  10. Select Add remote. This action opens a pull request in Redocly automatically. After refreshing your browser, you should see a View Pull Request button next to your new branch name.

Merge the open pull request in Redocly

After you enter the connection details in Redocly, a pull request to merge your updates with the default branch opens.

  1. Refresh your browser to see a View Pull Request button next to your new branch name.
  2. Select View Pull Request.
  3. Review your updates in the Review tab.
  4. After the tests have run and your pull request has been approved, click the Merge button to merge your updates with the default branch.
 
Next page