Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

UI Steps
sizesmall
UI Step

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 option 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.

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:

  • 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;
  • Job Name/Plan Key/Workflow Id/Project Id/Pipeline Id (Mandatory) - This is your reference for the the build project on your CI/CD;
  • 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 Modified



Mandatory fields

  • Name: a unique name for custom field
  • Test Type: Xray Test Type to be associated with the custom field. A user can configure different custom fields for different Test Types

...