{"id":15022475,"url":"https://github.com/elaichenkov/playwright-zephyr","last_synced_at":"2025-04-05T12:03:28.896Z","repository":{"id":37096078,"uuid":"421467747","full_name":"elaichenkov/playwright-zephyr","owner":"elaichenkov","description":"Zephyr reporter for the Playwright","archived":false,"fork":false,"pushed_at":"2024-10-28T20:30:38.000Z","size":1758,"stargazers_count":33,"open_issues_count":16,"forks_count":21,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-29T22:56:33.079Z","etag":null,"topics":["playwright","reporter","typescript","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":"2021-10-26T14:52:51.000Z","updated_at":"2024-10-28T20:30:35.000Z","dependencies_parsed_at":"2023-11-07T18:31:01.945Z","dependency_job_id":"c7d592be-224b-43dd-9c0a-8662b912ad92","html_url":"https://github.com/elaichenkov/playwright-zephyr","commit_stats":{"total_commits":144,"total_committers":2,"mean_commits":72.0,"dds":0.3055555555555556,"last_synced_commit":"3d27b4890b449bcf74bdf6cb7ab47af02841df6f"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elaichenkov%2Fplaywright-zephyr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elaichenkov%2Fplaywright-zephyr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elaichenkov%2Fplaywright-zephyr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elaichenkov%2Fplaywright-zephyr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elaichenkov","download_url":"https://codeload.github.com/elaichenkov/playwright-zephyr/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247332560,"owners_count":20921853,"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":["playwright","reporter","typescript","zephyr"],"created_at":"2024-09-24T19:58:00.377Z","updated_at":"2025-04-05T12:03:28.872Z","avatar_url":"https://github.com/elaichenkov.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zephyr reporter for Playwright\n\nPublish Playwright test run on Zephyr\n\n## Install\n\n```sh\nnpm i -D playwright-zephyr\n```\n\n## Usage\n\nAdd **Server** reporter to your `playwright.config.ts` configuration file\n\n```typescript\n// playwright.config.ts\nimport { PlaywrightTestConfig } from '@playwright/test';\n\nconst config: PlaywrightTestConfig = {\n  reporter: [['playwright-zephyr', { \n    host: 'https://jira.your-company-domain.com/',\n    authorizationToken: 'SVSdrtwgDSA312342--',\n    projectKey: 'JARV'\n  }]],\n}\n```\n\nIf you want to use **Cloud** reporter, you need to specify `cloud` option:\n\n```typescript\n// playwright.config.ts\nimport { PlaywrightTestConfig } from '@playwright/test';\n\nconst config: PlaywrightTestConfig = {\n  reporter: [\n    ['playwright-zephyr/lib/src/cloud', {\n      projectKey: 'JARV', // \u003c-- Replace with your project key\n      authorizationToken: process.env.ZEPHYR_AUTH_TOKEN, // \u003c-- Replace with your authorization token\n    }],\n  ],\n}\n```\n\nIf your test cycle requires custom fields, you can specify them in `testCycle` option:\n\n```typescript\n// playwright.config.ts\nimport { PlaywrightTestConfig } from '@playwright/test';\n\nconst config: PlaywrightTestConfig = {\n    reporter: [\n    ['playwright-zephyr/lib/src/cloud', {\n      projectKey: 'JARV', // \u003c-- Replace with your project key\n      authorizationToken: process.env.ZEPHYR_AUTH_TOKEN, // \u003c-- Replace with your authorization token\n      testCycle: {\n          name: `Automated Playwright Run - ${new Date().toISOString()}`,\n          customFields: {\n            Browser: 'Google Chrome',\n            Device: 'MacOS',\n          },\n        },\n    }],\n  ],\n}\n```\n\nRead how to get Zephyr authorization token [here](https://tm4j-cloud.elevio.help/en/articles/164).\n\nAlso, your playwright tests should include unique ID inside square brackets `[J79]` of your Zephyr test case:\n\n```typescript\n//      ↓  Zephyr test case ID inside square brackets\ntest('[J79] basic test', async ({ page }) =\u003e {\n  await page.goto('https://playwright.dev/');\n  const title = page.locator('.navbar__inner .navbar__title');\n  await expect(title).toHaveText('Playwright');\n});\n```\n\nThen run your tests with `npx playwright test` command and you'll see the result in console:\n\n```sh\n✅ Test cycle JARV-C2901 has been created\n👇 Check out the test result\n🔗 https://jira.your-company-domain.com/secure/Tests.jspa#/testPlayer/JARV-C2901\n```\n\nAnd you'll see the result in the Zephyr:\n\n![alt text](./assets/zephyr-result.png)\n\n## License\n\nplaywright-zephyr is [MIT licensed](./LICENSE).\n\n## Author\n\nYevhen Laichenkov \u003celaichenkov@gmail.com\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felaichenkov%2Fplaywright-zephyr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felaichenkov%2Fplaywright-zephyr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felaichenkov%2Fplaywright-zephyr/lists"}