- Introduction
- User support
- Known bugs/issues
- Defined variables
- Global plugin configuration
- Advanced features
- Compatibility
- Contributing to the Plugin
- Testing With Docker
- Release Workflow
- Changelog
This plugin allows GitLab to trigger builds in Jenkins when code is committed or merge requests are opened/updated. It can also send build status back to GitLab.
This plugin is Open Source Software, developed on a volunteer basis by users of Jenkins and GitLab. It is not formally supported by either GitLab Inc. or CloudBees Inc.
GitLab performs a new major release about every six to nine months, and they are constantly fixing bugs and adding new features. As a result, we cannot support this plugin when used with GitLab versions older than N-2, where N is the current major release. At the time of this writing, the current stable release of GitLab is 11.1, so the oldest release supported by this plugin is 9.0.
If you have a problem or question about using the plugin, please make sure you are using the latest version. Then create an issue in the GitHub project.
To enable debug logging in the plugin:
- Go to Jenkins -> Manage Jenkins -> System Log
- Add new log recorder
- Enter 'Gitlab plugin' or whatever you want for the name
- On the next page, enter 'com.dabsquared.gitlabjenkins' for Logger, set log level to FINEST, and save
- Then click on your Gitlab plugin log, click 'Clear this log' if necessary, and then use GitLab to trigger some actions
- Refresh the log page and you should see output
This is not an exhaustive list of issues, but rather a place for us to note significant bugs that may impact your use of the plugin in certain circumstances. For most things, please search the Issues section and open a new one if you don't find anything.
- #272 - Plugin version 1.2.0+ does not work with GitLab Enterprise Edition < 8.8.3. Subsequent versions work fine.
- Jenkins versions 1.651.2 and 2.3 removed the ability of plugins to set arbitrary job parameters that are not specifically defined in each job's configuration. This was an important security update, but it has broken compatibility with some plugins, including ours. See here for more information and workarounds if you are finding parameters unset or empty that you expect to have values.
- #473 - When upgrading from plugin versions older than 1.2.0, you must upgrade to that version first, and then to the latest version. Otherwise, you will get a NullPointerException in com.cloudbees.plugins.credentials.matchers.IdMatcher after you upgrade. See the linked issue for specific instructions.
- #608 - GitLab 9.5.0 - 9.5.4 has a bug that causes the "Test Webhook" function to fail when it sends a test to Jenkins. This was fixed in 9.5.5.
- #730 - GitLab 10.5.6 introduced an issue which can cause HTTP 500 errors when webhooks are triggered if the webhook is pointing to http://localhost or http://127.0.0.1. See the linked issue for a workaround.
When GitLab triggers a build via the plugin, various environment variables are set based on the JSON payload that GitLab sends. You can use these throughout your job configuration. The available variables are:
gitlabBranch
gitlabSourceBranch
gitlabActionType
gitlabUserName
gitlabUserUsername
gitlabUserEmail
gitlabSourceRepoHomepage
gitlabSourceRepoName
gitlabSourceNamespace
gitlabSourceRepoURL
gitlabSourceRepoSshUrl
gitlabSourceRepoHttpUrl
gitlabMergeRequestTitle
gitlabMergeRequestDescription
gitlabMergeRequestId
gitlabMergeRequestIid
gitlabMergeRequestState
gitlabMergedByUser
gitlabMergeRequestAssignee
gitlabMergeRequestLastCommit
gitlabMergeRequestTargetProjectId
gitlabTargetBranch
gitlabTargetRepoName
gitlabTargetNamespace
gitlabTargetRepoSshUrl
gitlabTargetRepoHttpUrl
gitlabBefore
gitlabAfter
gitlabTriggerPhrase
NOTE: These variables are not available in Pipeline Multibranch jobs.
By default the plugin will require authentication to be set up for the connection from GitLab to Jenkins, in order to prevent unauthorized persons from being able to trigger jobs.
APITOKENS and other secrets MUST not be send over unsecure connections. So, all connections SHOULD use HTTPS.
Note: Certificates are free and easy to manage with LetsEncrypt.
- Create a user in Jenkins which has, at a minimum, Job/Build permissions
- Log in as that user (this is required even if you are a Jenkins admin user), then click on the user's name in the top right corner of the page
- Click 'Configure,' then 'Show API Token...', and note/copy the User ID and API Token
- In GitLab, when you create webhooks to trigger Jenkins jobs, use this format for the URL and do not enter anything for 'Secret Token':
https://USERID:APITOKEN@JENKINS_URL/project/YOUR_JOB - After you add the webhook, click the 'Test' button, and it should succeed
If you want to create separate authentication credentials for each Jenkins job:
- In the configuration of your Jenkins job, in the GitLab configuration section, click 'Advanced'
- Click the 'Generate' button under the 'Secret Token' field
- Copy the resulting token, and save the job configuration
- In GitLab, create a webhook for your project, enter the trigger URL (e.g.
https://JENKINS_URL/project/YOUR_JOB) and paste the token in the Secret Token field - After you add the webhook, click the 'Test' button, and it should succeed
If you want to disable this authentication (not recommended):
- In Jenkins, go to Manage Jenkins -> Configure System
- Scroll down to the section labeled 'GitLab'
- Uncheck "Enable authentication for '/project' end-point" - you will now be able to trigger Jenkins jobs from GitLab without needing authentication
PLEASE NOTE: This auth configuration is only used for accessing the GitLab API for sending build status to GitLab. It is not used for cloning git repos. The credentials for cloning (usually SSH credentials) should be configured separately, in the git plugin.
This plugin can be configured to send build status messages to GitLab, which show up in the GitLab Merge Request UI. To enable this functionality:
- Create a new user in GitLab
- Give this user 'Maintainer' permissions on each repo you want Jenkins to send build status to
- Log in or 'Impersonate' that user in GitLab, click the user's icon/avatar and choose Settings
- Click on 'Access Tokens'
- Create a token named e.g. 'jenkins' with 'api' scope; expiration is optional
- Copy the token immediately, it cannot be accessed after you leave this page
- On the Global Configuration page in Jenkins, in the GitLab configuration section, supply the GitLab host URL, e.g.
https://your.gitlab.server - Click the 'Add' button to add a credential, choose 'GitLab API token' as the kind of credential, and paste your GitLab user's API key into the 'API token' field
- Click the 'Test Connection' button; it should succeed
There are two aspects of your Jenkins job that you may want to modify when using GitLab to trigger jobs. The first is the Git configuration, where Jenkins clones your git repo. The GitLab Plugin will set some environment variables when GitLab triggers a build, and you can use those to control what code is cloned from Git. The second is the configuration for sending the build status back to GitLab, where it will be visible in the commit and/or merge request UI.
If you want to be able to run jobs both manually and automatically via GitLab webhooks, you will need to configure parameters for those jobs. If you only want to trigger jobs from GitLab, you can skip this section.
Any GitLab parameters you create will always take precedence over the values that are sent by the webhook, unless you use the EnvInject plugin to map the webhook values onto the job parameters. This is due to changes that were made to address security vulnerabilities, with changes that landed in Jenkins 2.3.
In your job configuration, click 'This build is parameterized' and add any parameters you want to use. See the defined variables list for options - your parameter names must match these .e.g sourceBranch and targetBranch in the example Groovy Script below. Then, having installed EnvInject, click 'Prepare an environment for the run' and check:
- Keep Jenkins Environment Variables
- Keep Jenkins Build Variables
- Override Build Parameters
In the Groovy Script field insert something similar to:
def env = currentBuild.getEnvironment(currentListener)
def map = [:]
if (env.gitlabSourceBranch != null) {
map['sourceBranch'] = env.gitlabSourceBranch
}
if (env.gitlabTargetBranch != null) {
map['targetBranch'] = env.gitlabTargetBranch
}
return mapYou can then reference these variables in your job config, e.g. as ${sourceBranch}. You will need to update this code anytime you add or remove parameters.
Note: If you use the Groovy Sandbox, you might need to approve the script yourself or let an administrator approve the script in the Jenkins configuration.
In the Source Code Management section:
- Click Git
- Enter your Repository URL, such as
[email protected]:gitlab_group/gitlab_project.git- In the Advanced settings, set Name to
originand Refspec to+refs/heads/*:refs/remotes/origin/* +refs/merge-requests/*/head:refs/remotes/origin/merge-requests/*
- In the Advanced settings, set Name to
- In Branch Specifier enter:
- For single-repository workflows:
origin/${gitlabSourceBranch} - For forked repository workflows:
merge-requests/${gitlabMergeRequestIid}
- For single-repository workflows:
- In Additional Behaviours:
- Click the Add drop-down button
- Select Merge before build from the drop-down
- Set Name of repository to
origin - Set Branch to merge as
${gitlabTargetBranch}
-
A Jenkins Pipeline bug will prevent the Git clone from working when you use a Pipeline script from SCM. It works if you use the Jenkins job config UI to edit the script. There is a workaround mentioned here: https://issues.jenkins-ci.org/browse/JENKINS-33719
-
Use the Snippet generator, General SCM step, to generate sample Groovy code for the git checkout/merge etc.
-
Example that performs merge before build:
checkout changelog: true, poll: true, scm: [
$class: 'GitSCM',
branches: [[name: "origin/${env.gitlabSourceBranch}"]],
extensions: [[$class: 'PreBuildMerge', options: [fastForwardMode: 'FF', mergeRemote: 'origin', mergeStrategy: 'DEFAULT', mergeTarget: "${env.gitlabTargetBranch}"]]],
userRemoteConfigs: [[name: 'origin', url: '[email protected]:foo/testrepo.git']]
]Note: There is no way to pass external data from GitLab to a Pipeline Multibranch job, so the GitLab environment variables are not populated for this job type. GitLab will just trigger branch indexing for the Jenkins project, and Jenkins will build branches accordingly without needing e.g. the git branch env var. Due to this, the plugin just listens for GitLab Push Hooks for multibranch pipeline jobs; merge Request hooks are ignored.
- Click Add source
- Select Git
- Enter your Repository URL (e.g.:
[email protected]:group/repo_name.git)
Example Jenkinsfile for multibranch pipeline jobs:
// Reference the GitLab connection name from your Jenkins Global configuration (https://JENKINS_URL/configure, GitLab section)
properties([gitLabConnection('your-gitlab-connection-name')])
node {
checkout scm // Jenkins will clone the appropriate git branch, no env vars needed
// Further build steps happen here
}When you configure the plugin to trigger your Jenkins job, by following the instructions below depending on job type, it will listen on a dedicated URL for JSON POSTs from GitLab's webhooks. That URL always takes the form https://JENKINS_URL/project/PROJECT_NAME, or https://JENKINS_URL/project/FOLDER/PROJECT_NAME if the project is inside a folder in Jenkins. You should not be using https://JENKINS_URL/job/PROJECT_NAME/build or https://JENKINS_URL/job/gitlab-plugin/buildWithParameters, as this will bypass the plugin completely.
- In the Build Triggers section:
- Select Build when a change is pushed to GitLab
- Copy the GitLab webhook URL shown in the UI (see here for guidance)
- Use the check boxes to trigger builds on Push Events and/or Created Merge Request Events and/or Accepted Merge Request Events and/or Closed Merge Request Events
- Optionally use Rebuild open Merge Requests to enable re-building open merge requests after a push to the source branch
- If you selected Rebuild open Merge Requests other than None, check Comments, and specify the Comment for triggering a build. A new build will be triggered when this phrase appears in a commit comment. In addition to a literal phrase, you can also specify a Java regular expression
- You can use Build on successful pipeline events to trigger on a successful pipeline run in GitLab. Note that this build trigger will only trigger a build if the commit is not already built and does not set the GitLab status. Otherwise you might end up in a loop
- Configure any other pre build, build or post build actions as necessary
- Click Save to preserve your changes in Jenkins
- Create a webhook in the relevant GitLab projects (consult the GitLab documentation for instructions on this), and use the URL you copied from the Jenkins job configuration UI. It should look something like
https://JENKINS_URL/project/yourbuildname
Unlike other job types, there is no 'Trigger' setting required for a Multibranch job configuration; just create a webhook in GitLab for push requests which points to the project's webhook URL. When GitLab POSTs to this URL, it will trigger branch indexing for the Jenkins project, and Jenkins will handle starting any builds necessary.
If you want to configure some of the trigger options, such as the secret token or CI skip functionality, you can use a properties step. For example:
// Define your secret project token here
def project_token = 'abcdefghijklmnopqrstuvwxyz0123456789ABCDEF'
// Reference the GitLab connection name from your Jenkins Global configuration (https://JENKINS_URL/configure, GitLab section)
properties([
gitLabConnection('your-gitlab-connection-name'),
pipelineTriggers([
[
$class: 'GitLabPushTrigger',
branchFilterType: 'All',
triggerOnPush: true,
triggerOnMergeRequest: false,
triggerOpenMergeRequestOnPush: "never",
triggerOnNoteRequest: true,
noteRegex: "Jenkins please retry a build",
skipWorkInProgressMergeRequest: true,
secretToken: project_token,
ciSkip: false,
setBuildDescription: true,
addNoteOnMergeRequest: true,
addCiMessage: true,
addVoteOnMergeRequest: true,
acceptMergeRequestOnSuccess: false,
branchFilterType: "NameBasedFilter",
includeBranchesSpec: "release/qat",
excludeBranchesSpec: "",
]
])
])You can use the Dynamic DSL feature of Job DSL to configure the job trigger. See https://github.com/jenkinsci/gitlab-plugin/blob/master/src/main/java/com/dabsquared/gitlabjenkins/GitLabPushTrigger.java for the methods you can use.
job('seed-job') {
description('Job that makes sure a service has a build pipeline available')
parameters {
// stringParam('gitlabSourceRepoURL', '', 'the git repository url, e.g. [email protected]:kubernetes/cronjobs/cleanup-jenkins.git')
}
triggers {
gitlab {
// This line assumes you set the API_TOKEN as an env var before starting Jenkins - not necessarily required
secretToken(System.getenv("API_TOKEN"))
triggerOnNoteRequest(false)
}
}
steps {
dsl {
text(new File('/usr/share/jenkins/ref/jobdsl/multibranch-pipeline.groovy').getText('UTF-8'))
}
}
}You can optionally have your Jenkins jobs send their build status back to GitLab, where it will be displayed in the commit or merge request UI as appropriate.
Use 'Publish build status to GitLab' Post-build action to send build status with the given build name back to GitLab. 'Pending' build status is sent when the build is triggered, 'Running' status is sent when the build starts and 'Success' or 'Failed' status is sent after the build is finished.
Also make sure you have chosen the appropriate GitLab instance from the 'GitLab connection' dropdown menu, if you have more than one.
NOTE: If you use Pipeline global libraries, or if you clone your project's Jenkinsfile from a repo different from the one that contains the relevant source code, you need to be careful about when you send project status. In short, make sure you put your gitlabCommitStatus or other similar steps after the SCM step that clones your project's source. Otherwise, you may get HTTP 400 errors, or you may find build status being sent to the wrong repo.
- For Pipeline jobs, surround your build steps with the
gitlabCommitStatusstep like this:node() { stage('Checkout') { checkout <your-scm-config> } gitlabCommitStatus { // The result of steps within this block is what will be sent to GitLab sh 'mvn install' } } - Or use the
updateGitlabCommitStatusstep to use a custom value for updating the commit status. You could use try/catch blocks or other logic to send fine-grained status of the build to GitLab. Valid statuses are defined by GitLab and documented here: https://docs.gitlab.com/ce/api/pipelines.htmlnode() { stage('Checkout') { checkout <your-scm-config> } updateGitlabCommitStatus name: 'build', state: 'pending' // Build steps updateGitlabCommitStatus name: 'build', state: 'success' } - Or you can mark several build stages as pending in GitLab, using the
gitlabBuildsstep:Note: If you put thenode() { stage('Checkout') { checkout <your-scm-config> } gitlabBuilds(builds: ["build", "test"]) { stage("build") { gitlabCommitStatus("build") { // your build steps } } stage("test") { gitlabCommitStatus("test") { // your test steps } } } }gitlabBuildsblock inside a node block, it will not trigger until a node is allocated. On a busy system, or one where nodes are allocated on demand, there could be a delay here, and the 'pending' status would not be sent to GitLab right away. If this is a concern, you can move thegitlabBuildsblock to wrap the node block, and then the status will be sent when Jenkins starts trying to allocate a node.
The example below configures the GitLab connection and job triggers. It also sends build status back to GitLab.
NOTE: You will need to run this job manually once, in order for Jenkins to read and set up the trigger configuration. Otherwise webhooks will fail to trigger the job.
pipeline {
agent any
post {
failure {
updateGitlabCommitStatus name: 'build', state: 'failed'
}
success {
updateGitlabCommitStatus name: 'build', state: 'success'
}
}
options {
gitLabConnection('your-gitlab-connection-name')
}
triggers {
gitlab(triggerOnPush: true, triggerOnMergeRequest: true, branchFilterType: 'All')
}
stages {
stage("build") {
steps {
echo "hello world"
}
}
}
[...]
}If:
- You use the "Merge When Pipeline Succeeds" option for Merge Requests in GitLab, and
- Your Declarative Pipeline jobs have more than one stage, and
- You use a
gitlabCommitStatusstep in each stage to send status to GitLab...
Then:
You will need to define those stages in an options block. Otherwise, when and if the first stage passes, GitLab will merge the change. For example, if you have three stages named build, test, and deploy:
options {
gitLabConnection('your-gitlab-connection-name')
gitlabBuilds(builds: ['build', 'test', 'deploy'])
}If you want to configure any of the optional job triggers that the plugin supports in a Declarative build, use a triggers block. The full list of configurable trigger options is as follows:
triggers {
gitlab(
triggerOnPush: false,
triggerOnMergeRequest: true, triggerOpenMergeRequestOnPush: "never",
triggerOnNoteRequest: true,
noteRegex: "Jenkins please retry a build",
skipWorkInProgressMergeRequest: true,
ciSkip: false,
setBuildDescription: true,
addNoteOnMergeRequest: true,
addCiMessage: true,
addVoteOnMergeRequest: true,
acceptMergeRequestOnSuccess: false,
branchFilterType: "NameBasedFilter",
includeBranchesSpec: "release/qat",
excludeBranchesSpec: "",
pendingBuildName: "Jenkins",
cancelPendingBuildsOnUpdate: false,
secretToken: "abcdefghijklmnopqrstuvwxyz0123456789ABCDEF")
}To send 'Pending' build status to GitLab when the pipeline is triggered, set a build name to 'Pending build name for pipeline' field in the Advanced-section of the trigger configuration or use pendingBuildName option in the GitLab-trigger configuration in the declarative pipeline.
This plugin can be used with Matrix/Multi-configuration jobs together with the Flexible Publish plugin which allows you to run publishers after all axis jobs are done. Configure the Post-build Actions as follows:
- Add a Flexible publish action
- In the Flexible publish section:
- Add conditional action
- In the Conditional action section:
- Set Run? to Never
- Select Condition for Matrix Aggregation
- Set Run on Parent? to Always
- Add GitLab actions as required
- Violation Comments to GitLab Plugin for pipeline and job DSL examples.
Triggers may be filtered based on the branch name, i.e. the build will only be allowed for selected branches. On the project configuration page, when you configure the GitLab trigger, you can choose 'Filter branches by name' or 'Filter branches by regex.' Filter by name takes comma-separated lists of branch names to include and/or exclude from triggering a build. Filter by regex takes a Java regular expression to include and/or exclude.
Note: This functionality requires access to GitLab and a git repository url already saved in the project configuration. In other words, when creating a new project, the configuration needs to be saved once before being able to add branch filters. For Pipeline jobs, the configuration must be saved and the job must be run once before the list is populated.
In order to build when a new tag is pushed:
- In the GitLab webhook configuration, add 'Tag push events'
- In the job configuration under 'Source code management':
- Select 'Advanced...' and add '
+refs/tags/*:refs/remotes/origin/tags/*' as the Refspec - You can also use 'Branch Specifier' to specify which tag need to be built (example 'refs/tags/${TAGNAME}')
- Select 'Advanced...' and add '
To add a note to GitLab merge requests after the build completes, select 'Add note with build status on GitLab merge requests' from the optional Post-build actions. Optionally, click the 'Advanced' button to customize the content of the note depending on the build result.
addGitLabMRComment(comment: 'The pipeline was run on Jenkins')Note that it requires that the build be triggered by the GitLab MR webhook, not the push webhook (or manual build). Please also note that it currently does not work with Multibranch Pipeline jobs, because MR hooks won't trigger.
To accept a merge request when build is completed select 'Accept GitLab merge request on success' from the optional Post-build actions.
For pipeline jobs two advanced configuration options can be provided
- useMRDescription - Adds the merge request description into the merge commit, in a similar format as would be recieved by selecting 'Modify commit message' followed by 'include description in commit message' in GitLab UI
- removeSourceBranch - Removes the source branch in GitLab when the merge request is accepted
acceptGitLabMR(useMRDescription: true, removeSourceBranch: true)You can specify a map of project builds to notify a variety of GitLab repositories which could be located on different servers. This is useful if you want to create a complex CI/CD which involves several Jenkins and GitLab projects, see examples bellow:
- Notify several GitLab projects using GitLab connection data from the trigger context:
gitlabCommitStatus(name: 'stage1',
builds: [
[projectId: 'test/test', revisionHash: 'master'],
[projectId: 'test/utils', revisionHash: 'master'],
])
{
echo 'Hello World'
}- Notify several GitLab projects using specific GitLab connection:
gitlabCommitStatus( name: 'stage1', connection:gitLabConnection('site1-connection'),
builds: [
[projectId: 'test/test', revisionHash: 'master'],
[projectId: 'test/utils', revisionHash: 'master'],
])
{
echo 'Hello World'
}- Notify several GitLab repositories located on different GitLab servers:
gitlabCommitStatus(
builds: [
[name:'stage1',connection:gitLabConnection('site1-connection'), projectId: 'group/project1', revisionHash: 'master'],
[name:'stage1',connection:gitLabConnection('site2-connection'), projectId: 'group/project1', revisionHash: 'master'],
[name:'stage1',connection:gitLabConnection('site2-connection'), projectId: 'test/test', revisionHash: 'master'],
[name:'stage1',connection:gitLabConnection('site2-connection'), projectId: 'test/utils', revisionHash: 'master'],
])
{
echo 'Hello World'
}To cancel pending builds of the same merge request when new commits are pushed, check 'Cancel pending merge request builds on update' from the Advanced-section in the trigger configuration. This saves time in projects where builds can stay long time in a build queue and you care only about the status of the newest commit.
To make use of GitLab EE's group webhooks you will need to have specified an identifier when you create a GitLab connection in your Jenkins global configuration page. The resulting Global GitLab CI Service URL will be of the form http://JENKINS_URL/project/IDENTIFIER. GitLab's configuration is the same as described in the job trigger configuration section, except you navigate to a group's Settings page and supply the URL discussed here instead of a job specific one.
A webhook will fire for every relevant event of a direct child of the group, but only Jenkins projects configured for the firing GitLab connection, repository, and event type will trigger. The Global GitLab CI Service URL may of course be used in a project's settings just like a regular GitLab CI Service URL.
Version 1.2.1 of the plugin introduces a backwards-incompatible change for Pipeline jobs. They will need to be manually reconfigured when you upgrade to this version. Freestyle jobs are not impacted. Please see the README for details.
Plugin source code is hosted on GitHub. New feature proposals and bug fix proposals should be submitted as GitHub pull requests. Fork the repository on GitHub, prepare your change on your forked copy, and submit a pull request (see here for open pull requests). Your pull request will be evaluated by the plugin's CI job.
If you are adding new features please make sure that they support Jenkins Pipeline jobs. See here for some information.
Before submitting your change make sure that:
- your changes work with the oldest and latest supported GitLab version
- new features are provided with tests
- refactored code is provided with regression tests
- the code formatting follows the plugin standard
- imports are organised
- you updated the help docs
- you updated the README
- you have used findbugs to see if you haven't introduced any new warnings
See https://github.com/jenkinsci/gitlab-plugin/tree/master/src/docker/README.md 🙂
To perform a full plugin release, maintainers can run mvn release:prepare release:perform To release a snapshot, e.g. with a bug fix for users to test, just run mvn deploy
For recent versions, see GitHub Releases.
For versions 1.5.14 and older, see CHANGELOG.md.