Access "Remote Jobs Trigger" option on Project settings:
UI Step
Select the desired CI/CD platform to use by selecting "Enable..." configuration on the right. This step is needed only once and you can have only one CI/CD tool selected at a given time.
UI Step
Click the button "New Jenkins Configuration" to create a new configuration:
UI Step
The new configuration screen will be displayed and you can fill in the input field regarding your CI/CD platform.
Info
Be aware that the fields may differ according to the CI/CD platform selected but there are a few that are mandatory and cross CI/CD platforms
Generic fields:
Configuration Name (Mandatory) - Name of the configuration, this is the reference that will be used on Test Plan/Test Execution on the "Trigger Build" option;
Parameters (optional) - Key/value parameters list that you might have defined on your build and you want to pass from Xray. To add more parameters, just click he option "Add" to have a new Key/Value added to the list. To remove parameters, click the "x" option displayed right after the Key/Value row.
You may also use the following options to add to the parameter value regarding Xray entities:
${ISSUE_KEY} - this will be replaced with issue key that user is triggering the build from;
${TESTS_KEY} - this value will then be replaced with a comma separated string of test keys part of the issue the user is triggering the build from;
${PROJECT_KEY} - this value will then be replaced with project key;
${USER} - this value will then be replaced with logged user triggering the build. Image Added
CI/CD specific fields:
Jenkins:
Job Name (Mandatory) - Exact job name defined on your Jenkins instance;
API Token (Mandatory) - API token defined on Jenkins for this specific job;
Username (Mandatory) - Jenkins user ID/name;
API URL (Mandatory) - Jenkins endpoint url. e.g. jenkins.cloud.getxray.app/
Password (Mandatory) - Jenkins user password
Bamboo:
Plan key(Mandatory) - Exact job name defined on your Jenkins instance;
API URL (Mandatory) - Bamboo endpoint url. e.g. bamboo.cloud.getxray.app