{"id":18832602,"url":"https://github.com/ctco/zephyr-sync","last_synced_at":"2025-09-15T03:04:07.241Z","repository":{"id":45535637,"uuid":"65192957","full_name":"ctco/zephyr-sync","owner":"ctco","description":"Tool to synchronize test results to Zephyr (test management add-on for JIRA)","archived":false,"fork":false,"pushed_at":"2025-06-02T07:49:07.000Z","size":198,"stargazers_count":22,"open_issues_count":12,"forks_count":27,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-07-04T11:19:54.129Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ctco.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-08-08T09:50:23.000Z","updated_at":"2025-06-20T02:10:40.000Z","dependencies_parsed_at":"2025-01-10T11:34:02.274Z","dependency_job_id":null,"html_url":"https://github.com/ctco/zephyr-sync","commit_stats":{"total_commits":101,"total_committers":15,"mean_commits":6.733333333333333,"dds":0.6237623762376238,"last_synced_commit":"5848e15463d176a8add5fdf4f429a2d904173682"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/ctco/zephyr-sync","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctco%2Fzephyr-sync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctco%2Fzephyr-sync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctco%2Fzephyr-sync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctco%2Fzephyr-sync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ctco","download_url":"https://codeload.github.com/ctco/zephyr-sync/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctco%2Fzephyr-sync/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267242856,"owners_count":24058825,"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","status":"online","status_checked_at":"2025-07-26T02:00:08.937Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-08T01:58:20.783Z","updated_at":"2025-07-26T21:32:34.397Z","avatar_url":"https://github.com/ctco.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![wercker status](https://app.wercker.com/status/5f663d10cb826a4ebbbfaa7d2f6f1420/s/master \"wercker status\")](https://app.wercker.com/project/byKey/5f663d10cb826a4ebbbfaa7d2f6f1420)\r\n\r\n# Zephyr Sync\r\n\r\n## Overview\r\n\r\nZephyr Sync is a tool, that allows your project to perform synchronization of automated test results to Zephyr - a JIRA addon for Test Management. The advanced configuration of the tool supports multiple report types to work with, as well as some restrictions to be applied during the sync.\r\n\r\n## Usage example\r\n\r\n### Maven\r\n\r\nAll changes should be done inside `pom.xml`.\r\n\r\n#### Using zephyr-sync-maven-plugin (recommended)\r\n\r\nThe configuration is very simple and should be done in `pom.xml`\r\n(note that this example is given for `cucumber`, other reports like `allure` are configured in the similar way):\r\n\r\n```\r\n\u003cplugin\u003e\r\n    \u003cgroupId\u003elv.ctco.zephyr\u003c/groupId\u003e\r\n    \u003cartifactId\u003ezephyr-sync-maven-plugin\u003c/artifactId\u003e\r\n    \u003cversion\u003e${zephyr-sync.version}\u003c/version\u003e\r\n    \u003cdependencies\u003e\r\n        \u003cdependency\u003e\r\n            \u003cgroupId\u003elv.ctco.zephyr\u003c/groupId\u003e\r\n            \u003cartifactId\u003ezephyr-sync-report-cucumber\u003c/artifactId\u003e\r\n            \u003cversion\u003e${zephyr-sync.version}\u003c/version\u003e\r\n        \u003c/dependency\u003e\r\n    \u003c/dependencies\u003e\r\n    \u003cconfiguration\u003e\r\n        \u003cusername\u003eTECXYZ01\u003c/username\u003e\r\n        \u003cpassword\u003e${env.TECXYZ01_PWD}\u003c/password\u003e\r\n        \u003creportType\u003ecucumber\u003c/reportType\u003e\r\n        \u003cprojectKey\u003eXYZ\u003c/projectKey\u003e\r\n        \u003cjiraUrl\u003ehttp://jira.yourcompany.com/rest/\u003c/jiraUrl\u003e\r\n        \u003creleaseVersion\u003e1.0\u003c/releaseVersion\u003e\r\n        \u003creportPath\u003e${project.build.directory}/cucumber-report/report.json\u003c/reportPath\u003e\r\n    \u003c/configuration\u003e\r\n\u003c/plugin\u003e\r\n```\r\n\r\n#### Using maven-exec-plugin (deprecated)\r\nFirst of all - declare dependency to `zephyr-sync-core`:\r\n\r\n```\r\n\u003cdependencies\u003e\r\n    ...\r\n    \u003cdependency\u003e\r\n        \u003cgroupId\u003elv.ctco.zephyr\u003c/groupId\u003e\r\n        \u003cartifactId\u003ezephyr-sync-core\u003c/artifactId\u003e\r\n        \u003cversion\u003e${zephyr-sync.version}\u003c/version\u003e\r\n    \u003c/dependency\u003e\r\n\u003c/dependencies\u003e\r\n```\r\n\r\nAlso configure a Maven plugin that will trigger synchronization to JIRA:\r\n\r\n```\r\n\u003cplugin\u003e\r\n    \u003cgroupId\u003eorg.codehaus.mojo\u003c/groupId\u003e\r\n    \u003cartifactId\u003eexec-maven-plugin\u003c/artifactId\u003e\r\n    \u003cversion\u003e1.3.1\u003c/version\u003e\r\n    \u003cexecutions\u003e\r\n        \u003cexecution\u003e\r\n            \u003cid\u003edefault-cli\u003c/id\u003e\r\n            \u003cgoals\u003e\r\n                \u003cgoal\u003ejava\u003c/goal\u003e\r\n            \u003c/goals\u003e\r\n            \u003cconfiguration\u003e\r\n                \u003cmainClass\u003elv.ctco.zephyr.Runner\u003c/mainClass\u003e\r\n                \u003carguments\u003e\r\n                    \u003cargument\u003e--username=TECXYZ01\u003c/argument\u003e\r\n                    \u003cargument\u003e--password=${env.TECXYZ01_PWD}\u003c/argument\u003e\r\n                    \u003cargument\u003e--reportType=cucumber\u003c/argument\u003e\r\n                    \u003cargument\u003e--projectKey=XYZ\u003c/argument\u003e\r\n                    \u003cargument\u003e--releaseVersion=1.0\u003c/argument\u003e\r\n                    \u003cargument\u003e--jiraUrl=http://jira.yourcompany.com/rest/\u003c/argument\u003e\r\n                    \u003cargument\u003e--reportPath=${project.build.directory}/cucumber-report/report.json\u003c/argument\u003e\r\n                \u003c/arguments\u003e\r\n            \u003c/configuration\u003e\r\n        \u003c/execution\u003e\r\n    \u003c/executions\u003e\r\n\u003c/plugin\u003e\r\n\r\n```\r\n\r\nThis example shows only minimal set of mandatory attributes.\r\nFor complete list of attributes refer to sections below.\r\n\r\n### Command Line Interface\r\n\r\n```\r\njava -jar zephyr-sync-cli-${zephyr-sync.version}-all-in-one.jar --username=SPCABC --password=123456 --reportType=cucumber --projectKey=ABC --releaseVersion=\"Release 2.1\" --jiraUrl=http://jira.yourcompany.com/rest/ --reportPath=build/cucumber-report/report.json\r\n```\r\n\r\n### Using Gradle (using CLI)\r\n```\r\ntask zephyrSync {\r\n         javaexec {\r\n            main = \"lv.ctco.zephyr.Runner\"\r\n            classpath = sourceSets.main.output + sourceSets.test.output\r\n            args = [\"--username=SPCABC\", \"--password=123456\", \"--reportType=cucumber\", \"--projectKey=ABC\",\r\n                    \"--releaseVersion=Release 2.1\", \"--jiraUrl=http://jira.yourcompany.com/rest/\", \"--reportPath=build/cucumber-report/report.json\"]\r\n        }\r\n    }\r\n```\r\n\r\n## Configuration properties\r\n\r\nThis is the list of possible configuration items:\r\n\r\nProperty                  | Meaning                                                                                                                        | Is mandatory? | Default value | Example\r\n---                       | ---                                                                                                                            | ---           | ---           | ---\r\nusername                  | User name used to connect to JIRA                                                                                              | yes           |               | `TECXYZ01`\r\npassword                  | Password for the user to connect to JIRA                                                                                       | yes           |               | `password`\r\nreportType                | Type of report that will be synchronized to Zephyr                                                                             | yes           |               | One of `cucumber`, `allure`, `junit` or `nunit`\r\nprojectKey                | Key of project in JIRA                                                                                                         | yes           |               | `XYZ`\r\nreleaseVersion            | FixVersion of a project to link Test results to                                                                                | yes           |               | `1.0`\r\ntestCycle                 | Zephyr test cycle where the results will be linked to                                                                          | yes           |               |\r\njiraUrl                   | URL of JIRA (it's RESTful API endpoint)                                                                                        | yes           |               | `http://jira.yourcompany.com/jira/rest/\r\nreportPath                | Path on the file system where reports are stored                                                                               | yes           |               | For cucumber: `${project.build.directory}/cucumber-report/report.json`\r\norderedSteps              | If set to true, numerical prefix for test steps will be put (hierarchical)                                                     | no            | `false`       |\r\nforceStoryLink            | If set to true, sync will be failed in case at least one test doesn't have @Stories=ABC-XXX annotation                         | no            | `true`        |\r\ngenerateTestCaseUniqueId  | Name of JIRA attribute that is used to store unique ID of test case (will be used for test case tracking, updates and linking) | no            | `false`       |\r\nseverityAttribute         | Name of JIRA attribute that stores 'Severity' attribute                                                                        | no            |               |\r\nautoCreateTestCycle       | Should new test cycle be created automatically                                                                                 | no            | `true`        |\r\nassignee                  | Specify an Assignee                                                                                                            | no            |               |\r\nlinkType                  | Link type between Test issue and related story (used in combination with `@Stories` annotation)                                | no            | `Reference`   |\r\nlinkDirection             | Link direction between Test issue and related story                                                                            | no            | `inward`      | One of `inward` or `outward`\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctco%2Fzephyr-sync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fctco%2Fzephyr-sync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctco%2Fzephyr-sync/lists"}