Add a GitLab repo
If your project files are stored in a remote repository on GitLab, you can connect that repository, so you can access, edit, and publish those files in Redocly.
To connect a GitLab repo:
- Create new access token in GitLab.
- Enter the connection details 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:
Enter the connection details in Redocly
From your project, select Settings > Git hosting > GitLab.
Enter a Credential name that identifies this GitLab connection.
Enter the Access token you saved from the Create new access token in GitLab step and select Next.
Select the Namespace > Project > Branch.
(Optional) Select the Monorepo folder, if your project files are part of a monorepo, and you want to include only a specific folder from the repository.
Monorepo folderIf you select to only include a specific folder from a monorepo:
- Only files listed in file tree are cloned, no other files are included
- Project builds are started only when branch contains changes to connected folder
- Remote content is allowed to add to connected folder only
Select Next > Connect.
WarningThis step deletes the files currently in the Redocly project and replaces them with the files in GitLab.