Media
GitLab provides management of git repositories. The GitLab plug-in imports issues, commits, merge requests and builds from a GitLab server.
The GitLab plugin provides for integration with a GitLab server. This plugin imports issues, commits, merge requests and builds from a GitLab server and provides a single view of GitLab data in HCL DevOps Velocity value stream map. Data between the GitLab server and the HCL DevOps Velocity server is synchronized every five minutes.
This plugin requires GitLab version 9 or higher.
This plugin supports Cloud and On-Premises platforms.
Beginning with HCL DevOps Velocity version 2.4.0 users must enter a user access key is required to connect with the HCL DevOps Velocity server. If you are upgrading from a previous version, you must obtain and add the key to the HCL DevOps Velocity User Access Key configuration property. If the user access key is not added, the integration fails.
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.
The GitLab plugin supports scheduled events integration which are listed in the following table.
Name | Description |
---|---|
syncGitLabIssue | Queries the GitLab Server for issues in a project. |
syncGitLabPull | Queries the GitLab Server for merge requests in a project. |
syncGitLabCommit | Queries the GitLab Server for commits in a project. |
syncGitLabBuild | Queries the GitLab Server for builds in a project. |
To install the plug-in, perform the following steps:
There are two methods to integrate the plug-in:
Integrating the plug-in by using user interface
To integrate the plug-in using the user interface, perform the following steps:
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. Refer to the sample SJo
To integrate the plug-in using a JSON, perform the following steps:
The access token generated from Gitlab server requires the READ_API Permission of private repositories to connect to the Gitlab.
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.
Some properties might not be displayed in the user interface, to see all properties enable the Show Hidden Properties field.
Name | Description | Required | Property Name |
---|---|---|---|
NA | The version of the plugin that you want to use. To view available versions, click the Version History tab. If a value is not specified, the latest version is used. | No | image |
Integration Name | An assigned name to the value stream. | Yes | name</td |
Logging Level | The level of Log4j messages to display in the log file. Valid values are: all, debug, info, warn, error, fatal, off, and trace. | No | loggingLevel |
NA | List of configuration properties used to connect and communicate with the GitLab server. Enclose the properties within braces. | Yes | properties |
The name of the tenant. | Yes | tenant_id | |
NA | Unique identifier assigned to the plugin. The value for the GitLab plugin is ucv-ext-gitlab . |
Yes | type |
HCL DevOps Velocity User Access Key | An auto-generated user access key provides credentials for communicating with the HCL DevOps Velocity server. | Yes | NA |
Name | Type | Description | Required |
---|---|---|---|
URL | String | The URL of the GitLab server. | Yes |
Private Token | String | The Gitlab server access token. For more information, see the GitLab documentation. | Yes |
Project IDs | Array | Comma seperated list of GitLab Project IDs to import the source data. | Yes |
HCL DevOps Velocity User Access Key | String | The user access key used to authenticate with the HCL DevOps Velocity server. This property is not available starting with version 2.0.28 of the plugin. | Yes |
Branch Name | String | GitLab repositories branch, The branch to pull commits from. | No |
Additional Branches | Array | Comma seperated names of additional branches to collect commits from besides the main one, leave blank if not needed. | No |
Priority Field Mapping using Labels | Array | Map GitLab label for Priorty to this server. The priorty field label must be a key vaule pair connected by “:” or “-“. Example: If Gitlab Label for priorty is priortyKey:High, then pass priortyKey in this field. | No |
Proxy Server | String | The URL of the proxy server including the port number. | No |
Proxy User Name | String | The user name used to authenticate with the proxy server. | No |
Proxy Password | String | The password used to authenticate with the proxy server. | No |
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"
]
}
}
]
Uploaded: 20-Dec-2024 08:00
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.2.69
Uploaded: 07-Mar-2024 03:40
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.1.68
Uploaded: 13-Mar-2023 15:22
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.2.66
Uploaded: 30-Jan-2023 06:28
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.1.63
Uploaded: 22-Sep-2022 05:16
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.1.62
Uploaded: 13-Sep-2022 10:59
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.1.58
Uploaded: 18-Aug-2022 08:40
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.1.57
Uploaded: 13-Jun-2022 05:31
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.1.56
Uploaded: 06-Jun-2022 02:55
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.1.55
Uploaded: 05-Apr-2022 12:28
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.53
Uploaded: 24-Feb-2022 03:15
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.50
Uploaded: 03-Dec-2021 06:34
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.37
Uploaded: 08-Sep-2021 13:57
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.36
Uploaded: 25-Aug-2021 05:08
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.32
Uploaded: 11-Aug-2021 06:54
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.31
Uploaded: 09-Aug-2021 06:37
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.30
Uploaded: 30-Jun-2021 09:45
Uploaded: 04-May-2021 05:11
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.25
Uploaded: 03-Mar-2021 04:44
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.15
Uploaded: 08-Feb-2021 07:35
Uploaded: 08-Feb-2021 07:35
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.9
Uploaded: 08-Feb-2021 07:34
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.8
Uploaded: 08-Feb-2021 07:34