The GitLab plugin provides integration with the GitLab REST API to create, manage, and manipulate Git repositories. This plugin also adds support for GitLab CI/CD:
-
Continuous Integration (CI)
-
Continuous Delivery (CD)
-
Continuous Deployment (CD)
-
Trigger GitLab Pipeline
While the Git plugin provides the core functionality for managing Git repositories and associated data, the GitLab plugin provides the following, additional functionality:
| Supported features | Git plugin | GitLab plugin |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Reporting data: Build |
|
|
Reporting data: Code commit |
|
|
Reporting data: Deployment |
|
|
Reporting data: Feature |
|
|
Reporting data: Incident |
|
|
|
|
|
Webhook triggers |
|
|
Prerequisites
Because of the Java versions supported by CloudBees CD/RO, you can only use GitLab v1.1.0 and later with CloudBees CD/RO agents v10.11 and later.
GitLab REST API support
The GitLab plugin has been tested with the GitLab REST API v4.
GitLab webhook support
The GitLab plugin provides the ability to automate the launch of the CloudBees CD/RO runtimes for:
-
Confidential issue events
-
Issue events
-
Merge request events
-
Pipeline events
-
Push events
For more information, refer to Configure webhook triggers.
Supported runtime values according to the event type
When the procedure or pipeline is started by a webhook event, additional properties are available under the /myWebhook property sheet. These properties are parsed from the event payload, which itself is saved under /my(Job|PipelineRuntime|etc.)/webhookData. The list of parsed properties depends on the event type. In some cases, the event payload may not contain the data for a property, and it is missing.
The branch names in the Include Branches and Exclude Branches parameters are patterns; the value main corresponds to any branch that contains main (for example, test-main-data). To specify the exact branch, you must use line start and line end symbols (for example, ^main$).
|
| Runtime property | Confidential issue event | Issue event | Merge request event | Pipeline event | Push event |
|---|---|---|---|---|---|
branch |
|
|
|
|
|
commitAuthorEmail |
|
|
|
|
|
commitAuthorName |
|
|
|
|
|
commitId |
|
|
|
|
|
commitMessage |
|
|
|
|
|
eventType |
|
|
|
|
|
repository |
|
|
|
|
|
webhookData/action |
|
|
|
|
|
webhookData/branch |
|
|
|
|
|
webhookData/description |
|
|
|
|
|
webhookData/name |
|
|
|
|
|
webhookData/number |
|
|
|
|
|
webhookData/ref |
|
|
|
|
|
webhookData/stage |
|
|
|
|
|
webhookData/state |
|
|
|
|
|
webhookData/status |
|
|
|
|
|
webhookData/title |
|
|
|
|
|
webhookData/url |
|
|
|
|
|