GitLab


The GitLab integration allows you to preview live issue and merge request information from GitLab links in Outline documents. You can see the current status, timestamp, a preview of the description and labels associated with an issue. For merge requests the status is also displayed.

Config

To setup the integration navigate to Settings → Integrations → GitLab. You must have an admin role to be able to see this screen. Click the “Connect” button and authentication with either GitLab.com or your self-hosted instance.

Self hosted

For self-hosted deployments of GitLab you must first register an Application in GitLab, choose the following scopes:

  • read_api (Read API)

  • read_user (Read your personal information)


You will be given a “Client ID” and “Client secret” that can be entered into the setup in Outline to complete the installation.

Connect multiple organizations

If you have more than one GitLab organization it can be connected in the same way by navigating to the settings page and click on the “Connect” button that is now in the header.


Note: GitLab is linked once for the entire Outline workspace, other team members will be able to see issue and MR details from repositories that are linked in this way.

Usage

Once the integration is connected, paste an issue or merge request link from gitlab.com or your self-hosted instance into an Outline document and you will see the option to “mention” which displays detailed information inside the document.