Configuring webhook triggers in Jenkins for a Multibranch pipeline job

Optional (Applies only for the Postop Make Baseline Complete trigger): After completing Configuring webhook triggers in Jenkins

Postop Make Baseline Complete trigger script

The trigger is fired when the creation of a baseline is completed in a child stream of the integration stream configured in the Jenkins multibranch job for the desired VOB component. A new build of the affected stream will be started automatically in Jenkins.

Make sure you are in a view to create the postop mkbl_complete trigger complete.

Preop Deliver Start trigger script

The trigger is fired immediately on an attempt of a delivery operation, if the delivery is done from a stream, it creates a baseline and blocks the operation. If the delivery is done from a baseline , the trigger checks its Jenkins build attributes. When the baseline build attribute is COMPLETED_SUCCESFUL the delivery operation is allowed, otherwise it is blocked.

For more information about the Jenkins build attributes of a baseline, see the About the Enable build attributes on baseline section from Configuring the plug-in for a Multibranch pipeline job for the DevOps Code ClearCase-Jenkins integration.

Make sure you are in a view to create the preop deliver_start trigger.

MultiSite baseline polling script

The trigger is fired from a MultiSite environment when new baselines have been created in a replication packet and the packet is scanned before its import to the master VOB. After the packet import the Jenkins multibranch job will be called to scan for new baselines.

1. Install the Multibranch Scan Webhook Trigger plugin in Jenkins.

   1. Select Manage Jenkins > Manage Plugins > Available Plugins.

   2. Search for the Multibranch Scan Webhook Trigger plugin and mark the Install check box.

   3. Click on the Install button.

2. Set the token for the Multibranch Scan Webhook Trigger plugin.

   1. Go to the Multibranch job settings.

   2. Find the Scan Multibranch Pipeline Triggers section.

   3. Select the Scan by webhook check box.

   4. Enter the trigger token and click on the Save button.

3. Set up a RECEIPT_HANDLER for the MultiSite master replica to look at the sync_receive script. For UNIX, see shipping.conf.

   For Windows see: MultiSite Control Panel.

   For more information about the sync_receive script, see sync_receive.

4. For UNIX and Windows systems, open the sync_receive.bat script and insert the following code below the mentioned lines. Ensure to edit the location path of the Jenkins MultiSite Baseline Polling script according to the step 4 from the Create trigger scripts in DevOps Code ClearCase section before inserting the code:

   Line 690.

   For UNIX:

   # if new mkbaseline operations to be imported were found in the packet,
   # run the MultiSite Baseline Polling script to start a Baseline scan in the 
   Jenkins instance.
   if ($exit_code_jenkins == 0) {
       dbgprint "***** Starting the MultiSite Baseline Polling script 
   execution\n";
       system("$interpreter
   /SCRIPT/LOCATION/PATH/jenkins_multisite_baseline_polling_script.pl");
       dbgprint "\n***** Finished the MultiSite Baseline Polling script 
   execution.\n";
   }
   

   For Windows:

   # if new mkbaseline operations to be imported were found in the packet,
   # run the MultiSite Baseline Polling script to start a Baseline scan in the 
   Jenkins instance.
   if ($exit_code_jenkins == 0) {
       dbgprint "***** Starting the MultiSite Baseline Polling script 
   execution\n";
       system("$interpreter  <Drive 
   Letter>:\\SCRIPT\\LOCATION\\PATH\\jenkins_multisite_baseline_polling_script.pl");
       dbgprint "\n***** Finished the MultiSite Baseline Polling script 
   execution.\n";
   }
   

   Example of how the code must look like:

   
   
   

   Line 625.

   For UNIX:

   my $interpreter = $Config{perlpath};
   $exit_code_jenkins = 1;
   # if the packet file exists, run the MultiSite Baseline Polling script to 
   scan the packet looking for new mkbaseline operations.
   # the script will return 0 if new mkbaseline operations to be imported were 
   found.
   if (-e $pkt) {
       dbgprint "***** Starting the MultiSite Baseline Polling script 
   execution\n";
       $exit_code_jenkins = system("$interpreter 
   /SCRIPT/LOCATION/PATH/jenkins_multisite_baseline_polling_script.pl -pkt 
   $pkt");
       dbgprint "***** MultiSite Baseline Polling script exit code: 
   $exit_code_jenkins\n";
   }
   

   For Windows:

   my $interpreter = $Config{perlpath};
   $exit_code_jenkins = 1;
   # if the packet file exists, run the MultiSite Baseline Polling script to 
   scan the packet looking for new mkbaseline operations.
   # the script will return 0 if new mkbaseline operations to be imported were 
   found.
   if (-e $pkt) {
       dbgprint "***** Starting the MultiSite Baseline Polling script 
   execution\n";
       $exit_code_jenkins = system("$interpreter <Drive Letter>:\\SCRIPT\\LOCATION\\PATH\\jenkins_multisite_baseline_polling_script.
   pl -pkt \"$pkt\"");
       dbgprint "***** MultiSite Baseline Polling script exit code: 
   $exit_code_jenkins\n";
   };
   

   Example of how the code must look like:

   
   
   

   Line 465

   my $exit_code_jenkins;

   Example of how the code must look like:

   
   
   
5. Test the script by importing a replication packet which contains new baselines and verifying the newly generated baseline scan in Jenkins.

   Note: The debug output of the sync_receive.bat script can be enabled by uncommenting the code line number 74. To uncomment the code, delete the # symbol at the beginning of the line. The shipping_receive_log file is stored in the /var/adm/rational/ccase/log directory on Linux and the UNIX system and the \var\log directory on Windows.

   Example of how the code must look like: