{"id":16175890,"url":"https://github.com/elaichenkov/cypress-zephyr","last_synced_at":"2025-03-16T10:31:17.628Z","repository":{"id":207810532,"uuid":"716580665","full_name":"elaichenkov/cypress-zephyr","owner":"elaichenkov","description":"Cypress reporter and plugin for Zephyr Scale","archived":false,"fork":false,"pushed_at":"2024-10-07T23:03:10.000Z","size":1681,"stargazers_count":8,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-11T04:46:41.760Z","etag":null,"topics":["cypress","e2e","reporting","testing","zephyr"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/elaichenkov.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-09T12:42:33.000Z","updated_at":"2024-10-07T23:02:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"29f3a937-d250-4633-bb75-91e0770bc044","html_url":"https://github.com/elaichenkov/cypress-zephyr","commit_stats":{"total_commits":122,"total_committers":2,"mean_commits":61.0,"dds":0.1311475409836066,"last_synced_commit":"a4d7334dbf4b75b676962b4864c37fc840b9ace4"},"previous_names":["elaichenkov/cypress-zephyr"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elaichenkov%2Fcypress-zephyr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elaichenkov%2Fcypress-zephyr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elaichenkov%2Fcypress-zephyr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elaichenkov%2Fcypress-zephyr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elaichenkov","download_url":"https://codeload.github.com/elaichenkov/cypress-zephyr/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221662734,"owners_count":16859737,"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":["cypress","e2e","reporting","testing","zephyr"],"created_at":"2024-10-10T04:46:40.792Z","updated_at":"2024-10-27T10:25:29.888Z","avatar_url":"https://github.com/elaichenkov.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cypress-zephyr\n\n## Description\n\nThis is a Cypress plugin that allows you to link your Cypress tests to Zephyr test cases and upload Cypress test results to Zephyr.\n\n## Installation\n\n```shell\nnpm install -D cypress-zephyr\n```\n\n## Usage\n\nYou need to add the following to your `cypress.config.ts` file:\n\n```ts\nimport zephyrPlugin from 'cypress-zephyr/dist/plugin';\n\nexport default defineConfig({\n  reporter: 'cypress-zephyr',\n  reporterOptions: {\n    projectKey: 'HEX', // Jira and Zephyr project key\n    authorizationToken: process.env.ZEPHYR_AUTHORIZATION_TOKEN,\n  },\n  e2e: {\n    setupNodeEvents(on, config) {\n      zephyrPlugin(on, config);\n    },\n  },\n});\n```\n\nDo not forget to add `ZEPHYR_AUTHORIZATION_TOKEN` to your environment variables. The token can be generated in Zephyr settings. Read more about it [here](https://support.smartbear.com/zephyr-scale-cloud/docs/rest-api/generating-api-access-tokens.html).\n\n## Test case linking\n\nTo link your Cypress test to a Zephyr test case you need to add a `[R432]` tag to your test case title. The tag should contain a test case key.\n\nFor example, your test case id in Zephyr is `HEX-R432` then you need to add `[R432]` to your test case title. For instance:\n\n```ts\ndescribe('Main page', () =\u003e {\n  it('[R432] should do something', () =\u003e {\n    // ...\n  });\n});\n```\n\nAfter that you can run your tests as usual and see the results in Zephyr by clicking the link from terminal. The link will be printed after the tests are finished. Something like this:\n\n```shell\n📋 Zephyr Scale Report details:\n┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐\n│ ✅ Test cycle HEX-R9374 has been created                                                                                                                                        │\n│ 👇 Check out the test result                                                                                                                                                    │\n│ 🔗 https://company-x.atlassian.net/projects/HEX?selectedItem=com.atlassian.plugins.atlassian-connect-plugin%3Acom.kanoah.test-manager__main-project-page#!/testPlayer/HEX-R9374 │\n└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘\n```\n\nPlease take a look at the [examples](./examples/) for different set up.\n\n## Author\n\nYevhen Laichenkov \u003celaichenkov@gmail.com\u003e\n\n## License\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felaichenkov%2Fcypress-zephyr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felaichenkov%2Fcypress-zephyr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felaichenkov%2Fcypress-zephyr/lists"}