Versions Compared

Key

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

...

  1. Go to the Update Center of Jenkins in Manage Jenkins > Manage Plugins.
  2. Select the advanced Advanced tab
  3. In the Upload Plugin section, click upload and select the file xray-connector.hpi file.

...

Since version 2.1.0, you can install the plugin by using the Jenkins native Web UI. You can read more about how to to do it here.

Configuration

Xray for Jenkins is configured in the global settings configuration page  Manage Jenkins > Configure System > Xray for Jira configuration.

Credential permissions

If you want to ket your Jenkins' users to use their own Jira credentials in each build, you need to make sure that the users that need to configure the jobs have both USE ITEM and USE OWN permissions.

These permissions are not configurable in the Credentials plugin by default, you need to run your Jenkins instance with the following flags enabled:

     -Dcom.cloudbees.plugins.credentials.UseOwnPermission=true -Dcom.cloudbees.plugins.credentials.UseItemPermission=true

After enabling these flags, go to the Credentials plugin configuration page, and give the required users the USE ITEM and USE OWN permissions.

You can read more about these permissions in the official CloudBees documentation.

Jira Instance

The Jira configuration defines connections with Jira instances. 

...

  1. Configuration alias
  2. Hosting: Hosting (instance type) in this case Server/Data Center.
  3. Server Address: The address of the Jira Server where Xray is running
  4. Credentials:
    1. Use the Jenkins Credentials Plugin to set the API key/secret (please check Global Settings: API Keys for more info on creating API keys)
    2. Make sure that was used to create the API key has the following permissions in the projects where you want to import the results and import/export feature files: View, Edit, Create.
    3. This field is optional - if you don't want to use a System scoped credential to authenticate in your instance, you can leave this field empty and force the users to use an a User scoped credential in the build task.

...

Note: the Configuration ID is not editable. This value can be used in the pipelines pipeline scripts.

Info
titlePlease note

The user present in this configuration must exist in the Jira instance and have permission to Create Test and Test Execution Issues in the target project

...

  • Freestyle projects
  • Maven Projects
  • Multi-configuration Projects
  • Pipeline Projects

In On the home page, clicking click for example New Item > Freestyle project, provide a name, and then click OK.

...