Usage

To use the GitLab plugin, the plugin must be loaded and an instance created before you can configure the plugin integration. You define configuration properties in the user interface or in a JSON file.

Integration type

The GitLab plugin supports scheduled events integration which are listed in the following table.

Integration

There are two methods to integrate the plugin:

• Using the user interface
• Using a JSON file

The tables in the Configuration properties topic describe the properties used to define the integration.

Using the user interface

1. From the Plugins page, click Settings > Integrations > Plugins.
2. Under the Action column for the plugin, click Add Integration.
3. On the Add Integration page enter values for the fields used to configure the integration and define communication.
4. Click Save.

Using a JSON file

The JSON file contains the information for creating a value stream. Within the JSON file is a section for integrations. It is in this section that plugin properties can be defined.

1. From a value stream page, download the value stream map. The value stream map is a JSON file used to define integrations.
2. Edit the JSON file to include the plugin configuration properties.
3. Save and upload the JSON file. This replaces the current JSON file with the new content.
4. View the new integration on the Integrations page.

Minimum permission to integrate with GitLab

The access token generated from Gitlab server requires the READ_API Permission of private repositories to connect to the Gitlab.

Configuration Properties

The following tables describe the properties used to configure the integration. Each table contains the field name when using the user interface and the property name when using a JSON file.

• The General Configuration Properties table describes configuration properties used by all plugin integrations.
• The GitLab Configuration Properties table describes the configuration properties that define the connection and communications with the GitLab server.

Some properties might not be displayed in the user interface, to see all properties enable the Show Hidden Properties field.

JSON code example

The following example can be used as a template to define the integration within the JSON file for a value stream. Copy and paste the template into the JSON file and make the appropriate changes.

"integrations":[
   {
      "type":"ucv-ext-gitlab",
      "tenant_id":"tenantId",
      "name":"my-repo",
      "disabled":false,
      "properties":{
         "ucvAccessKey":"key",
         "baseUrl":"https://gitlab.com",
         "private_token":"token",
         "projectIds":[
            "8918",
            "12345"
         ],
        "proxyServer": "https://localhost:3128",
        "proxyUsername": "admin",
        "proxyPassword": "1234",
        "fieldMapping:[
            "priorityKey1",
            "priorityKey2"
        ]
      }
   }
]

Automation Tasks

The following Automation Tasks are available in the GitLab plugin.

• gitlabDeployApp

Run gitlabDeployApp

Runs a gitlabDeployApp.