Media
- Overview
- Documentation
- Version history
Description
GitLab provides management of git repositories. The GitLab plug-in imports issues, commits, merge requests and builds from a GitLab server.
Quick Info
Product
HCL DevOps Velocity (HCL Accelerate)
Type
plugin
Compatibility
GitLab version 9 or higher
Created by
HCLSoftware
Website
Published Date
Last Updated
Summary
Usage
Configuration Properties
Summary
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.
Compatibility
This plugin requires GitLab version 9 or higher.
This plugin supports Cloud and On-Premises platforms.
Upgrade notes
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.
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.
| 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. |
Integration
To install the plug-in, perform the following steps:
- In HCL DevOps Velocity, click Settings > Integrations > Available.
- In the Action column for the GitLab plug-in, click Install.
There are two methods to integrate the plug-in:
- Using the user interface
- Using a JSON file
Integrating the plug-in by using user interface
To integrate the plug-in using the user interface, perform the following steps:
- In HCL DevOps Velocity, click Settings > Integrations > Installed.
- In the Action column for the GitLab plug-in, click Add Integration.
- On the Add Integration dialog, enter the values for the fields to configure the integration and define communication.
- Click Add.
Integrating the plug-in by using 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. Refer to the sample SJo
To integrate the plug-in using a JSON, perform the following steps:
- Navigate to value stream page, and then click the necessary value stream.
- Click
icon, and then Select Edit value stream to modify the JSON file in the code or tree view editors. - Alternatively, you can also click Download JSON option to download the JSON file, and then select the Import JSON option to upload the revised JSON file.
- Edit the integration information in the JSON file to add the plug-in configuration properties. Refer to JSON sample code in the Configuration Properties section more details.
- Click Save.
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.
| 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 |
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"
]
}
}
]
- 2.2.69
- 2.2.68
- 2.2.66
- 2.1.63
- 2.1.62
- 2.1.58
- 2.1.57
- 2.1.56
- 2.1.55
- 2.0.53
- 2.0.50
- 2.0.37
- 2.0.36
- 2.0.32
- 2.0.31
- 2.0.30
- 2.0.28
- 2.0.25
- 2.0.15
- 2.0.10
- 2.0.9
- 2.0.8
- 2.0.7
Version
ucv-ext-gitlab:2.2.69.tar
Uploaded: 20-Dec-2024 08:00
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.2.69
Release Notes
- Fixed the approvers/reviews data missing from pull request data.
ucv-ext-gitlab:2.2.68.tar
Uploaded: 07-Mar-2024 03:40
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.1.68
Release Notes
- Minor Bug Fix: Dynamically getting type of issue.
ucv-ext-gitlab:2.2.66.tar
Uploaded: 13-Mar-2023 15:22
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.2.66
Release Notes
- Fix for Project Name Field: Previous version of Gitlab plugin was not able to import data for some projects.
- Project IDs Field Added: To import the source data you need to provide a list of GitLab Project IDs. Please note that you must provide at least one of either Project Names or Project IDs and can provide both if needed.
ucv-ext-gitlab:2.1.63.tar
Uploaded: 30-Jan-2023 06:28
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.1.63
Release Notes
- Minor Bug Fix: Previous version of plugin was giving Cannot read property status of null error
ucv-ext-gitlab:2.1.62.tar
Uploaded: 22-Sep-2022 05:16
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.1.62
Release Notes
- Resolved 502 Bad Gateway Error: Previous version of plugin was giving a 502 Bad Gateway error for GitLab Server.
ucv-ext-gitlab:2.1.58.tar
Uploaded: 13-Sep-2022 10:59
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.1.58
Release Notes
- Removed Manual User Access Key: From current version onwards this plugin will only support Auto Generated User Access Key feature of HCL Accelerate.
- Preventing Installation on Older Versions: This version of GitLab Plugin can only be installed on HCL Accelerate version 3.0.0 and later.
- Resolved Previous Version Issue: Previous Version of plugin had some defect related to Project Names field. The plugin was syncing data only for those projects which were owned by the user. Now the plugin syncs data for the projects in which user is a member at any level.
- Added Category: ALM | SCM | Build | Deploy are the categories of GitLab plugin.
ucv-ext-gitlab:2.1.57.tar
Uploaded: 18-Aug-2022 08:40
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.1.57
Release Notes
- Added project names :Removed project IDs property and added project names property. Instead of using array of Project IDs , an array of project names are used. While integrating user must provide comma separated list of project names.
- Wild card implementation :Supports wildcard functionality for project names. Example : *Sample, *Sample*, Sample*.
ucv-ext-gitlab:2.1.56.tar
Uploaded: 13-Jun-2022 05:31
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.1.56
Release Notes
- Minor Change
ucv-ext-gitlab:2.1.55.tar
Uploaded: 06-Jun-2022 02:55
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.1.55
Release Notes
- Automation Task Added
ucv-ext-gitlab:2.0.53.tar
Uploaded: 05-Apr-2022 12:28
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.53
Release Notes
- other Branches field added with datasince filed removed and historicaldata in vsm fixed
ucv-ext-gitlab:2.0.50.tar
Uploaded: 24-Feb-2022 03:15
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.50
Release Notes
- status value modified
ucv-ext-gitlab:2.0.37.tar
Uploaded: 03-Dec-2021 06:34
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.37
Release Notes
- UAK Changes
ucv-ext-gitlab:2.0.36.tar
Uploaded: 08-Sep-2021 13:57
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.36
Release Notes
- Support for priority using labels
ucv-ext-gitlab:2.0.32.tar
Uploaded: 25-Aug-2021 05:08
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.32
Release Notes
- UAK support for older versions
ucv-ext-gitlab:2.0.31.tar
Uploaded: 11-Aug-2021 06:54
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.31
Release Notes
- ReSync support added
ucv-ext-gitlab:2.0.30.tar
Uploaded: 09-Aug-2021 06:37
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.30
Release Notes
- Auto-generated UAK update
ucv-ext-gitlab:2.0.28.tar
Uploaded: 30-Jun-2021 09:45
ucv-ext-gitlab:2.0.25.tar
Uploaded: 04-May-2021 05:11
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.25
Release Notes
- Added history to Issues and PR
ucv-ext-gitlab:2.0.15.tar
Uploaded: 03-Mar-2021 04:44
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.15
Release Notes
- bug fixed
ucv-ext-gitlab:2.0.10.tar
Uploaded: 08-Feb-2021 07:35
ucv-ext-gitlab:2.0.9.tar
Uploaded: 08-Feb-2021 07:35
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.9
Release Notes
- Added retry for errors
ucv-ext-gitlab:2.0.8.tar
Uploaded: 08-Feb-2021 07:34
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-gitlab:2.0.8
Release Notes
- Added proxy support
ucv-ext-gitlab:2.0.7.tar
Uploaded: 08-Feb-2021 07:34