{"id":15144607,"url":"https://github.com/jenkinsci/xray-connector-plugin","last_synced_at":"2025-09-29T13:31:21.373Z","repository":{"id":42190858,"uuid":"214234140","full_name":"jenkinsci/xray-connector-plugin","owner":"jenkinsci","description":"Xray Test Management Connector for Jenkins","archived":false,"fork":true,"pushed_at":"2022-08-30T10:23:01.000Z","size":56357,"stargazers_count":16,"open_issues_count":12,"forks_count":13,"subscribers_count":6,"default_branch":"develop","last_synced_at":"2024-09-27T10:42:21.651Z","etag":null,"topics":["ci","ci-cd","cucumber","jenkins","jira-xray","junit","robot-framework","test-automation","testing","testing-tools","testng","xunit"],"latest_commit_sha":null,"homepage":"https://plugins.jenkins.io/xray-connector/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"xpandit/xrayjenkins","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jenkinsci.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-10T16:37:45.000Z","updated_at":"2024-04-18T19:34:14.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jenkinsci/xray-connector-plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fxray-connector-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fxray-connector-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fxray-connector-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fxray-connector-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jenkinsci","download_url":"https://codeload.github.com/jenkinsci/xray-connector-plugin/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234624047,"owners_count":18862274,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ci","ci-cd","cucumber","jenkins","jira-xray","junit","robot-framework","test-automation","testing","testing-tools","testng","xunit"],"created_at":"2024-09-26T10:42:31.961Z","updated_at":"2025-09-29T13:31:15.913Z","avatar_url":"https://github.com/jenkinsci.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Xray – Test Management for Jira\n\n## Continuous Integration using Jenkins and Xray\n  \nThis plugin enables continuous integration using Jenkins and Xray Test\nManagement. In a nutshell, this connector provides tasks to publish test\nresults from Jenkins to Xray.  \n\n![](https://user-images.githubusercontent.com/11166836/72537100-68457b80-3873-11ea-97a9-7c3b1025362d.png)\n\nXray is the leading Quality Assurance and Test Management app for Jira. More than 4.5 million testers, developers and QA managers trust Xray to manage 100+ million test cases each month. Xray is a mission-critical tool at over 5,000 companies in 70+ countries, including 137 of the Global 500.\n\n**Full Documentation**\n\nThe guide below it's a \"Quick Start\" version of our full documentation available in Xray official page:\n\n-   Xray Cloud integration with Jenkins: \u003chttps://docs.getxray.app/display/XRAYCLOUD/Integration+with+Jenkins\u003e\n-   Xray Server/DC integration with Jenkins: \u003chttps://docs.getxray.app/display/XRAY/Integration+with+Jenkins\u003e\n\nYou can also check the source code of the plugin here: \u003chttps://github.com/jenkinsci/xray-connector-plugin\u003e\n  \n\n### Features\n\n-   Integration with both Xray in Jira Cloud and Jira Server/Data Center\n-   Export Cucumber features files from Xray\n-   Import Cucumber feature files to Xray\n-   Import your test results in any format supported by Xray\n\n### Requirements\n\n-   Jenkins 2.138.4 or above\n-   At least one Jira instance (Server, Data Center and/or Cloud) with\n    the\n    [Xray](https://marketplace.atlassian.com/apps/1211769/xray-test-management-for-jira)\n    installed.\n\n### Configuration\n\nXray for Jenkins is configured in the global settings configuration page:\n\n**Manage Jenkins** \\\u003e **Configure System \\\u003e Xray configuration**.\n\u003cbr/\u003e\u003cbr/\u003e\n\nTo add a new Jira instance connection, you need to specify some\nproperties:\n\n1.  **Configuration alias:** the name you want to give to this\n    configuration\n2.  **Hosting:** Hosting (instance type) in this case Cloud/Server/Data\n    Center\n3.  **(Server/Data Center only) Server Address**: The address of the\n    Jira Server where Xray is running\n4.  Credentials:  \n    1.  Use the **Jenkins Credentials Plugin** to set the\n        username/password (if you are using a Server/Data Center\n        instance) or an API key/secret (if you are using an Cloud\n        instance)\n    2.  Make sure that the user you are using have the following\n        permissions in the projects where you want to import the results\n        and import/export feature files: **View, Edit, Create**\n\nNote: the Configuration ID is not editable. This value can be used in\nthe pipelines scripts.\n\u003cbr/\u003e\u003cbr/\u003e\nAfter setting the instances, you can test your connection to Jira, by\nusing the and ***Test Connection*** button.\nWhen you are done configuring your Jira instances, don't forget to\nsave the changes.\n![](https://user-images.githubusercontent.com/11166836/72537278-c1151400-3873-11ea-80df-f10b2d993305.png)\n\n### Job Tasks\n\nCurrently, we support **Freestyle**, **Pipeline**, **Multi-configuration\nProjects** and **Maven projects**.\n\nThis plugin provides 2 new Build tasks:\n\nThe ***Xray: Cucumber Features Export Task*** and the ***Xray: Cucumber\nFeatures Import Task***\n\nBoth tasks can be used while executing Cucumber tests: In a\ntypical [Cucumber Workflow](https://docs.getxray.app/display/XRAY/Integration+with+Jenkins#IntegrationwithJenkins-Cucumber(%22standard%22workflow)),\nafter having created a Cucumber project and the Cucumber tests specified\nin Jira, you may want to have a project that **exports** the features\nfrom Jira, executes the automated tests on a CI environment and then\n**imports** back its results.\n\nFor this scenario, the Jenkins project would be configured with a set of\ntasks responsible for:\n\n1.  Pulling the Cucumber project\n2.  **Exporting Cucumber features from Jira to your Cucumber project**\n3.  Executing the tests in the CI environment\n4.  **Importing the execution results back to Jira** ([see section below](#import-results))\n\nAlternatively, you can also use Cucumber features that are hosted outside Xray and import them to Jira by using our **Cucumber Features Import Task**.\n  \n![](https://user-images.githubusercontent.com/11166836/72537276-c1151400-3873-11ea-8cc0-c26a5af113de.png)\n\n#### Import Results\n\nIn the **Post-build Actions**, you can add the ***Xray: Results Import\nTask***, in order to import your Test Results in the following formats:\n\n-   Xray JSON \u0026 Xray JSON Multipart\n-   Cucumber JSON \u0026 Cucumber JSON Multipart\n-   Behave JSON \u0026 Behave JSON Multipart (Xray Server/Data Center only)\n-   JUnit XML \u0026 JUnit XML Multipart\n-   NUnit XML \u0026 NUnit XML Multipart\n-   Robot XML \u0026 Robot XML Multipart\n-   TestNG XML \u0026 TestNG XML Multipart\n-   xUnit XML \u0026 xUnit XML Multipart\n\n![](https://user-images.githubusercontent.com/11166836/72537277-c1151400-3873-11ea-9a1b-f3baebc2c33f.png)\n\n  \n### Want to learn more?\n\nCheck out [Xray Test Management website](https://getxray.app?utm_source=jenkins-connector\u0026utm_medium=github\u0026utm_campaign=jenkins-connector) to understand how to leverage Jira for Test Management and [start a free trial](https://marketplace.atlassian.com/apps/1211769/xray-test-management-for-jira?utm_source=jenkins-connector\u0026utm_medium=github\u0026utm_campaign=jenkins-connector).\n\nIf you need any help using in Xray or this plugin, you can contact us by using our [Support System](https://xraysupport.xpand-it.com/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fxray-connector-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjenkinsci%2Fxray-connector-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fxray-connector-plugin/lists"}