Compatibility

Introduction

Before you start

Configuration

Configure the webhook

Configure the Global Configurations of the Plugin

Configure your Jenkins job

Authentication for state notification and generally when using the Bitbucket REST API

Bitbucket Events supported by the plugin

Interaction with the git plugin

Some examples

Troubleshooting: Some important aspects to keep in mind

About the initialization of the plugin

About the filters on the branches

Environment variables

Dsl Job actions for Bitbucket Push and Pull Request Trigger

bitbucketTriggers {// For Bitbucket Cloud    repositoryPushAction(triggerAlsoIfTagPush:boolean,triggerAlsoIfNothingChanged:boolean,allowedBranches:String)    repositoryPushAction(triggerAlsoIfTagPush:boolean,triggerAlsoIfNothingChanged:boolean,allowedBranches:String,isToApprove:boolean)    repositoryPushAction(triggerAlsoIfTagPush:boolean,triggerAlsoIfNothingChanged:boolean,allowedBranches:String,isToApprove:boolean,triggerOnlyIfTagPush:boolean)    pullRequestApprovedAction(onlyIfReviewersApproved:boolean)    pullRequestApprovedAction(onlyIfReviewersApproved:boolean,allowedBranches:String)    pullRequestApprovedAction(onlyIfReviewersApproved:boolean,allowedBranches:String,isToApprove:boolean)    pullRequestCreatedAction()    pullRequestCreatedAction(allowedBranches:String)    pullRequestCreatedAction(allowedBranches:String,isToApprove:String)    pullRequestUpdatedAction()    pullRequestUpdatedAction(allowedBranches:String)    pullRequestUpdatedAction(allowedBranches:String,isToApprove:String)    pullRequestMergedAction()    pullRequestMergedAction(allowedBranches:String)    pullRequestMergedAction(allowedBranches:String,isToApprove:String)    pullRequestDeclinedAction()    pullRequestDeclinedAction(allowedBranches:String)    pullRequestCommentCreatedAction()    pullRequestCommentCreatedAction(allowedBranches:String)    pullRequestCommentCreatedAction(allowedBranches:String,commentFilter:String)// CommentFilter is java a regex expression    pullRequestCommentUpdatedAction()    pullRequestCommentUpdatedAction(allowedBranches:String)    pullRequestCommentUpdatedAction(allowedBranches:String,commentFilter:String)// CommentFilter is java a regex expression    pullRequestCommentDeletedAction()    pullRequestCommentDeletedAction(allowedBranches:String)// For Bitbucket Server// note: flag `isToApprove` has no effect yet    repositoryServerPushAction(triggerAlsoIfTagPush:boolean,triggerAlsoIfNothingChanged:boolean,allowedBranches:String)    repositoryServerPushAction(triggerAlsoIfTagPush:boolean,triggerAlsoIfNothingChanged:boolean,allowedBranches:String,isToApprove:boolean)    repositoryServerPushAction(triggerAlsoIfTagPush:boolean,triggerAlsoIfNothingChanged:boolean,allowedBranches:String,isToApprove:boolean,triggerOnlyIfTagPush:boolean)    pullRequestServerApprovedAction(onlyIfReviewersApproved:boolean)    pullRequestServerApprovedAction(onlyIfReviewersApproved:boolean,allowedBranches:String)    pullRequestServerApprovedAction(onlyIfReviewersApproved:boolean,allowedBranches:String,isToApprove:boolean)    pullRequestServerCreatedAction()    pullRequestServerCreatedAction(allowedBranches:String)    pullRequestServerCreatedAction(allowedBranches:String,isToApprove:boolean)    pullRequestServerUpdatedAction()    pullRequestServerUpdatedAction(allowedBranches:String)    pullRequestServerUpdatedAction(allowedBranches:String,isToApprove:boolean)    pullRequestServerSourceUpdatedAction()    pullRequestServerSourceUpdatedAction(allowedBranches:String)    pullRequestServerSourceUpdatedAction(allowedBranches:String,isToApprove:boolean)    pullRequestServerMergedAction()    pullRequestServerMergedAction(allowedBranches:String)    pullRequestServerMergedAction(allowedBranches:String,isToApprove:boolean)    pullRequestServerDeclinedAction()    pullRequestServerDeclinedAction(allowedBranches:String)    pullRequestServerCommentCreatedAction()    pullRequestServerCommentCreatedAction(allowedBranches:String)    pullRequestServerCommentCreatedAction(allowedBranches:String,commentFilter:String)}

Dsl Job snippets

Valid for freestyle jobs and pipeline jobs (until job-dsl plugin v1.76, deprecated in v1.77 for pipeline jobs)

// pullRequestCreatedAction()job('example-pull-request-created') {    triggers {        bitbucketTriggers {            pullRequestCreatedAction()        }    }    scm {        git {            remote {                url("https://git.company.domain/scm/~username/telegram.git")            }        }    }    steps {        shell('echo START pull request created')    }}// pullRequestCreatedAction() with filter on branchesjob('example-pull-request-created-with-filter-on-branches') {    triggers {        bitbucketTriggers {            pullRequestCreatedAction("master")        }    }    scm {        git {            remote {                url("https://git.company.domain/scm/~username/telegram.git")            }        }    }    steps {        shell('echo START pull request created with filter on branches')    }}// pullRequestCreatedAction() with filter on branches// and eventually approve Pull Request in BB after the job is donejob('example-pull-request-created-with-filter-on-branches-and-is-to-approve') {    triggers {        bitbucketTriggers {            pullRequestCreatedAction("master",true)        }    }    scm {        git {            remote {                url("https://git.company.domain/scm/~username/telegram.git")            }        }    }    steps {        shell('echo START pull request created with filter on branches')    }}// pullRequestUpdatedAction()job('example-pull-request-updated') {    triggers {        bitbucketTriggers {            pullRequestUpdatedAction()        }    }    scm {        git {            remote {                url("https://git.company.domain/scm/~username/telegram.git")            }        }    }    steps {        shell('echo START pull request updated')    }}// pullRequestUpdatedAction() wiht filter on branchesjob('example-pull-request-updated-with-filter-on-branches') {    triggers {        bitbucketTriggers {            pullRequestUpdatedAction("master")        }    }    scm {        git {            remote {                url("https://git.company.domain/scm/~username/telegram.git")            }        }    }    steps {        shell('echo START pull request updated with filter on branches')    }}// pullRequestUpdatedAction() wiht filter on branches// and eventually approve Pull Request in BB after the job is donejob('example-pull-request-updated-with-filter-on-branches') {    triggers {        bitbucketTriggers {            pullRequestUpdatedAction("master",true)        }    }    scm {        git {            remote {                url("https://git.company.domain/scm/~username/telegram.git")            }        }    }    steps {        shell('echo START pull request updated with filter on branches')    }// pullRequestApprovedAction(boolean onlyIfReviewersApproved)    job('example-pull-request-approved') {        triggers {            bitbucketTriggers {                pullRequestApprovedAction(false)            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START pull request approved')        }    }// pullRequestApprovedAction(boolean onlyIfReviewersApproved) with filter on branches    job('example-pull-request-approved-with-filter-on-branches') {        triggers {            bitbucketTriggers {                pullRequestApprovedAction(false,"master")            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START pull request approved with filter on branches')        }    }// pullRequestApprovedAction(boolean onlyIfReviewersApproved) with filter on branches// and eventually approve Pull Request in BB after the job is done    job('example-pull-request-approved-with-filter-on-branches') {        triggers {            bitbucketTriggers {                pullRequestApprovedAction(false,"master",true)            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START pull request approved with filter on branches')        }    }// pullRequestMergedAction()    job('example-pull-request-merged') {        triggers {            bitbucketTriggers {                pullRequestMergedAction()            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START pull request merged')        }    }// pullRequestMergedAction() with filter on branches    job('example-pull-request-merged-with-filter-on-branches') {        triggers {            bitbucketTriggers {                pullRequestMergedAction("master")            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START pull request merged with filter on branches')        }    }// pullRequestMergedAction() with filter on branches// and eventually approve Pull Request in BB after the job is done    job('example-pull-request-merged-with-filter-on-branches') {        triggers {            bitbucketTriggers {                pullRequestMergedAction("master")            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START pull request merged with filter on branches')        }    }// repositoryPushAction(boolean triggerAlsoIfTagPush, boolean triggerAlsoIfNothingChanged, String allowedBranches)    job('example-push') {        triggers {            bitbucketTriggers {                repositoryPushAction(false,true,"master")            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START push')        }    }// repositoryPushAction(boolean triggerAlsoIfTagPush, boolean triggerAlsoIfNothingChanged, String allowedBranches)// and eventually approve Pull Request in BB after the job is done    job('example-push') {        triggers {            bitbucketTriggers {// and eventually approve Pull Request in BB after the job is done                repositoryPushAction(false,true,"master",true)            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START push')        }    }// combination of triggers is also possible    job('example-pull-request-created-updated') {        triggers {            bitbucketTriggers {                pullRequestCreatedAction()                pullRequestUpdatedAction()                pullRequestMergedAction("master")            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START pull request created')        }    }

Valid for pipeline with job-dsl 1.77+ (and before)

ERROR: Scripts not permitted to use method groovy.lang.GroovyObject invokeMethod java.lang.String java.lang.Object (javaposse.jobdsl.dsl.jobs.WorkflowJob bitbucketTrigger script$_run_closure1$_closure5$_closure24$_closure29$_closure30$_closure31)

// pullRequestCreatedAction()job('example-pull-request-created') {    properties {        pipelineTriggers {            triggers {                bitBucketTrigger {                    triggers {                        bitBucketPPRPullRequestTriggerFilter {                            actionFilter {                                bitBucketPPRPullRequestCreatedActionFilter {                                }                            }                        }                    }                }            }        }    }    scm {        git {            remote {                url("https://git.company.domain/scm/~username/telegram.git")            }        }    }    steps {        shell('echo START pull request created')    }}// pullRequestCreatedAction() with filter on branchesjob('example-pull-request-created-with-filter-on-branches') {    properties {        pipelineTriggers {            triggers {                bitBucketTrigger {                    triggers {                        bitBucketPPRPullRequestTriggerFilter {                            actionFilter {                                bitBucketPPRPullRequestCreatedActionFilter {                                    allowedBranches("master")                                }                            }                        }                    }                }            }        }    }    scm {        git {            remote {                url("https://git.company.domain/scm/~username/telegram.git")            }        }    }    steps {        shell('echo START pull request created with filter on branches')    }}// pullRequestCreatedAction() with filter on branches// and eventually approve Pull Request in BB after the job is donejob('example-pull-request-created-with-filter-on-branches-and-is-to-approve') {    properties {        pipelineTriggers {            triggers {                bitBucketTrigger {                    triggers {                        bitBucketPPRPullRequestTriggerFilter {                            actionFilter {                                bitBucketPPRPullRequestCreatedActionFilter {                                    allowedBranches("master")                                    isToApprove(true)                                }                            }                        }                    }                }            }        }    }    scm {        git {            remote {                url("https://git.company.domain/scm/~username/telegram.git")            }        }    }    steps {        shell('echo START pull request created with filter on branches')    }}// pullRequestUpdatedAction()job('example-pull-request-updated') {    properties {        pipelineTriggers {            triggers {                bitBucketTrigger {                    triggers {                        bitBucketPPRPullRequestTriggerFilter {                            actionFilter {                                bitBucketPPRPullRequestUpdatedActionFilter {                                }                            }                        }                    }                }            }        }    }    scm {        git {            remote {                url("https://git.company.domain/scm/~username/telegram.git")            }        }    }    steps {        shell('echo START pull request updated')    }}// pullRequestUpdatedAction() wiht filter on branchesjob('example-pull-request-updated-with-filter-on-branches') {    properties {        pipelineTriggers {            triggers {                bitBucketTrigger {                    triggers {                        bitBucketPPRPullRequestTriggerFilter {                            actionFilter {                                bitBucketPPRPullRequestUpdatedActionFilter {                                    allowedBranches("master")                                }                            }                        }                    }                }            }        }    }    scm {        git {            remote {                url("https://git.company.domain/scm/~username/telegram.git")            }        }    }    steps {        shell('echo START pull request updated with filter on branches')    }}// pullRequestUpdatedAction() wiht filter on branches// and eventually approve Pull Request in BB after the job is donejob('example-pull-request-updated-with-filter-on-branches') {    properties {        pipelineTriggers {            triggers {                bitBucketTrigger {                    triggers {                        bitBucketPPRPullRequestTriggerFilter {                            actionFilter {                                bitBucketPPRPullRequestUpdatedActionFilter {                                    allowedBranches("master")                                    isToApprove(true)                                }                            }                        }                    }                }            }        }    }    scm {        git {            remote {                url("https://git.company.domain/scm/~username/telegram.git")            }        }    }    steps {        shell('echo START pull request updated with filter on branches')    }// pullRequestApprovedAction(boolean onlyIfReviewersApproved)    job('example-pull-request-approved') {        properties {            pipelineTriggers {                triggers {                    bitBucketTrigger {                        triggers {                            bitBucketPPRPullRequestTriggerFilter {                                actionFilter {                                    bitBucketPPRPullRequestApprovedActionFilter {                                        triggerOnlyIfAllReviewersApproved(false)                                    }                                }                            }                        }                    }                }            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START pull request approved')        }    }// pullRequestApprovedAction(boolean onlyIfReviewersApproved) with filter on branches    job('example-pull-request-approved-with-filter-on-branches') {        properties {            pipelineTriggers {                triggers {                    bitBucketTrigger {                        triggers {                            bitBucketPPRPullRequestTriggerFilter {                                actionFilter {                                    bitBucketPPRPullRequestApprovedActionFilter {                                        triggerOnlyIfAllReviewersApproved(false)                                        allowedBranches("master")                                    }                                }                            }                        }                    }                }            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START pull request approved with filter on branches')        }    }// pullRequestApprovedAction(boolean onlyIfReviewersApproved) with filter on branches// and eventually approve Pull Request in BB after the job is done    job('example-pull-request-approved-with-filter-on-branches') {        properties {            pipelineTriggers {                triggers {                    bitBucketTrigger {                        triggers {                            bitBucketPPRPullRequestTriggerFilter {                                actionFilter {                                    bitBucketPPRPullRequestApprovedActionFilter {                                        triggerOnlyIfAllReviewersApproved(false)                                        allowedBranches("master")                                        isToApprove(true)                                    }                                }                            }                        }                    }                }            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START pull request approved with filter on branches')        }    }// pullRequestMergedAction()    job('example-pull-request-merged') {        properties {            pipelineTriggers {                triggers {                    bitBucketTrigger {                        triggers {                            bitBucketPPRPullRequestTriggerFilter {                                actionFilter {                                    bitBucketPPRPullRequestMergedActionFilter {                                    }                                }                            }                        }                    }                }            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START pull request merged')        }    }// pullRequestMergedAction() with filter on branches    job('example-pull-request-merged-with-filter-on-branches') {        properties {            pipelineTriggers {                triggers {                    bitBucketTrigger {                        triggers {                            bitBucketPPRPullRequestTriggerFilter {                                actionFilter {                                    bitBucketPPRPullRequestMergedActionFilter {                                        allowedBranches("master")                                    }                                }                            }                        }                    }                }            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START pull request merged with filter on branches')        }    }// pullRequestMergedAction() with filter on branches// and eventually approve Pull Request in BB after the job is done    job('example-pull-request-merged-with-filter-on-branches') {        properties {            pipelineTriggers {                triggers {                    bitBucketTrigger {                        triggers {                            bitBucketPPRPullRequestTriggerFilter {                                actionFilter {                                    bitBucketPPRPullRequestMergedActionFilter {                                        allowedBranches("master")                                        isToApprove(true)                                    }                                }                            }                        }                    }                }            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START pull request merged with filter on branches')        }    }// repositoryPushAction(boolean triggerAlsoIfTagPush, boolean triggerAlsoIfNothingChanged, String allowedBranches)    job('example-push') {        properties {            pipelineTriggers {                triggers {                    bitBucketTrigger {                        triggers {                            bitBucketPPRRepositoryTriggerFilter {                                actionFilter {                                    bitBucketPPRRepositoryPushActionFilter {                                        triggerAlsoIfTagPush(false)                                        triggerAlsoIfNothingChanged(true)                                        allowedBranches("master")                                    }                                }                            }                        }                    }                }            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START push')        }    }// repositoryPushAction(boolean triggerAlsoIfTagPush, boolean triggerAlsoIfNothingChanged, String allowedBranches)// and eventually approve Pull Request in BB after the job is done    job('example-push') {        properties {            pipelineTriggers {                triggers {                    bitBucketTrigger {// and eventually approve Pull Request in BB after the job is done                        triggers {                            bitBucketPPRRepositoryTriggerFilter {                                actionFilter {                                    bitBucketPPRRepositoryPushActionFilter {                                        triggerAlsoIfTagPush(false)                                        triggerAlsoIfNothingChanged(true)                                        allowedBranches("master")                                        isToApprove(true)                                    }                                }                            }                        }                    }                }            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START push')        }    }// combination of triggers is also possible    job('example-pull-request-created-updated') {        properties {            pipelineTriggers {                triggers {                    bitBucketTrigger {                        triggers {                            bitBucketPPRPullRequestTriggerFilter {                                actionFilter {                                    bitBucketPPRPullRequestCreatedActionFilter {                                    }                                }                            }                            bitBucketPPRPullRequestTriggerFilter {                                actionFilter {                                    bitBucketPPRPullRequestUpdatedActionFilter {                                    }                                }                            }                            bitBucketPPRPullRequestTriggerFilter {                                actionFilter {                                    bitBucketPPRPullRequestMergedActionFilter {                                        allowedBranches("master")                                    }                                }                            }                        }                    }                }            }        }        scm {            git {                remote {                    url("https://git.company.domain/scm/~username/telegram.git")                }            }        }        steps {            shell('echo START pull request created')        }    }

Second (more verbose) valid dsl for freestyle jobs

freeStyleJob('test-job') {    triggers {        bitBucketTrigger {            triggers {                bitBucketPPRPullRequestTriggerFilter {                    actionFilter {                        bitBucketPPRPullRequestUpdatedActionFilter {                            isToApprove(true)                        }                    }                }            }        }    }}

Pipeline script

properties([        pipelineTriggers([                [                        $class  :'BitBucketPPRTrigger',triggers: [                                [                                        $class      :'BitBucketPPRPullRequestTriggerFilter',actionFilter: [                                                $class:'BitBucketPPRPullRequestCreatedActionFilter',                                        ]                                ],                                [                                        $class      :'BitBucketPPRPullRequestTriggerFilter',actionFilter: [                                                $class:'BitBucketPPRPullRequestApprovedActionFilter',                                        ]                                ],                                [                                        $class      :'BitBucketPPRPullRequestTriggerFilter',actionFilter: [                                                $class:'BitBucketPPRPullRequestUpdatedActionFilter',                                        ]                                ],                                [                                        $class      :'BitBucketPPRPullRequestTriggerFilter',actionFilter: [                                                $class:'BitBucketPPRPullRequestMergedActionFilter',                                        ]                                ],                                [                                        $class      :'BitBucketPPRRepositoryTriggerFilter',actionFilter: [                                                $class                     :'BitBucketPPRRepositoryPushActionFilter',triggerAlsoIfNothingChanged:true,triggerAlsoIfTagPush       :false,allowedBranches            :"",isToApprove                :true                                        ]                                ]                        ]                ]        ])])pipeline {    agent any    stages {        stage('Build') {            steps {                echo'Building...'                echo'Env vars for cloud pull request...'                echo"BITBUCKET_SOURCE_BRANCH${env.BITBUCKET_SOURCE_BRANCH}"                echo"BITBUCKET_TARGET_BRANCH${env.BITBUCKET_TARGET_BRANCH}"                echo"BITBUCKET_PULL_REQUEST_LINK${env.BITBUCKET_PULL_REQUEST_LINK}"                echo"BITBUCKET_PULL_REQUEST_ID${env.BITBUCKET_PULL_REQUEST_ID}"                echo"BITBUCKET_PAYLOAD${env.BITBUCKET_PAYLOAD}"                echo'Env vars for cloud push...'                echo"REPOSITORY_LINK${env.REPOSITORY_LINK}"                echo"BITBUCKET_SOURCE_BRANCH${env.BITBUCKET_SOURCE_BRANCH}"                echo"BITBUCKET_REPOSITORY_URL${env.BITBUCKET_REPOSITORY_URL}"                echo"BITBUCKET_PUSH_REPOSITORY_UUID${env.BITBUCKET_PUSH_REPOSITORY_UUID}"                echo"BITBUCKET_PAYLOAD${env.BITBUCKET_PAYLOAD}"                echo'Env vars for server push...'                echo"REPOSITORY_LINK${env.REPOSITORY_LINK}"                echo"BITBUCKET_SOURCE_BRANCH${env.BITBUCKET_SOURCE_BRANCH}"                echo"BITBUCKET_REPOSITORY_URL${env.BITBUCKET_REPOSITORY_URL}"                echo"BITBUCKET_PUSH_REPOSITORY_UUID${env.BITBUCKET_PUSH_REPOSITORY_UUID}"                echo"BITBUCKET_PAYLOAD${env.BITBUCKET_PAYLOAD}"            }        }    }}

Thanks and Acknowledgments