Page Comparison

Version 4.2 of Webhook to Jenkins for Bitbucket version 4.2 and onwards higher support sending custom URL parameters to Jenkins during the notification/trigger process. But this will not work unless Jenkins has been configured to allow url parametersTo use this feature, you must also configure Jenkins to allow URL parameters.

Setup

Configuring Jenkins

Git Plugin for Jenkins version 2.5.0 and onwards higher will by default reject all url URL parameters. You must configure Jenkins to allow URL parameters by doing ONE of the following:

• Setting the Jenkins JVM switches -Dhudson.model.ParametersAction.keepUndefinedParameters=true and -Dhudson.plugins.git.GitStatus.allowNotifyCommitParameters=true.

...

•  This allows arbitrary notify commit parameters (reference). Only enable this if you trust all unauthenticated users not to

...

• pass harmful arguments to your jobs.

• Setting the Jenkins JVM switch -Dhudson.plugins.git.GitStatus.safeParameters=PARM1,PARM1.

...

•  If this property is set to a comma-separated list of parameters,

...

• those parameters

...

• are allowed for any job. Only set this value for parameters you trust in all the jobs in your system.

For detailed instructions on adding Java arguments to Jenkins, see the CloudBees guidehere. 

Usage

Configure Bitbucket Server

1. Go Log in to your hook settings, then go to Webhook to Bitbucket for Jenkins → Advanced Configuration → URL Parameters → ParametersBitbucket repository and navigate to Repository Settings > Hooks > Enable or click the Edit setting for Webhooks to Jenkins Server icon.

2. Click the  Advanced Configuration taband locate URL Parameters at the bottom of the dialog.

3. Enter the URL parameter into the parameter boxfield. The rules for the parameters are as follows:

   • The formatting for the

   url

   • URL parameter is DESIRED_VARIABLE_NAME={PARAMETER_NAME}. 

   • Every parameter

   must start

   • starts on a new line.

   Name

   • The name given to your parameter

   whatever you'd like, this

   • is how you

   're going to

   • reference the parameter in Jenkins. In our example

   we're going to name

   • the parameter

   e.g. TARGET

   • name is TARGET_BRANCH.

   • To pull information from Bitbucket to use as a parameter (like the branch name),

   look at the table below and put it

   • refer to the Available parameters section and enter the parameter on the right side of the equal sign

   and surround it

   • surrounded with curly braces

   , e.g. 

   • {BRANCH_NAME}

   If you want to put

   • .

   • To use your own custom value,

   just

   • eliminate the curly braces and

   put

   • enter the value

   at

   • to the right

   side

   • of the equal sign.

...

Configure Jenkins

To be able to access the parameter in your Jenkins job do the following:

1. Go to your project configuration, then job, click Configure from the left sidebar and go to the General tab. Select This project is parameterized.Put

2. click Add Parameter and select String Parameter

3. in the Name field, enter the name of the parameter that you chose above (URL Parameter settings in the webhook) in the name boxused in the Webhook to Jenkins URL Parameters field.

4. For each additional parameter, click Add Parameter, select String Parameter and enter the name of the next parameter.

5. Click Save.

You should now have your parameters passed to Jenkins.

...

Available Parameters

Here's a list of available parameters:To pull information from Bitbucket to use as a parameter (like the branch name), refer to the table below and put the parameter on the right side of the equal sign and surround it with curly braces.

For example, TARGET_BRANCH={PR_DESTINATION}, where PR_DESTINATION is the branch name of the destination branch.

...