{"id":26226367,"url":"https://github.com/ctrf-io/jira-test-reporter","last_synced_at":"2026-02-13T23:10:23.775Z","repository":{"id":281733757,"uuid":"889848943","full_name":"ctrf-io/jira-test-reporter","owner":"ctrf-io","description":"Create Jira issues with test results from popular testing frameworks","archived":false,"fork":false,"pushed_at":"2025-10-16T20:16:26.000Z","size":661,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-17T23:03:26.401Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://ctrf.io","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/ctrf-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-11-17T12:01:45.000Z","updated_at":"2025-10-16T20:15:48.000Z","dependencies_parsed_at":null,"dependency_job_id":"58761279-88e0-4d61-b790-2485a35b2034","html_url":"https://github.com/ctrf-io/jira-test-reporter","commit_stats":null,"previous_names":["ctrf-io/jira-test-reporter"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/ctrf-io/jira-test-reporter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctrf-io%2Fjira-test-reporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctrf-io%2Fjira-test-reporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctrf-io%2Fjira-test-reporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctrf-io%2Fjira-test-reporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ctrf-io","download_url":"https://codeload.github.com/ctrf-io/jira-test-reporter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctrf-io%2Fjira-test-reporter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29422575,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-13T22:20:51.549Z","status":"ssl_error","status_checked_at":"2026-02-13T22:20:49.838Z","response_time":78,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":"2025-03-12T19:19:23.114Z","updated_at":"2026-02-13T23:10:23.768Z","avatar_url":"https://github.com/ctrf-io.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jira Test Results Notification\n\n\u003e Create a Jira issue with test results from popular testing frameworks\n\nA Jira test reporting tool that supports all major testing frameworks.\nGenerate, publish and alert your team with detailed test results, including\nsummaries, in-depth reports, failed test analyses, flaky test detection directly to your chosen Jira project.\n\n\u003cdiv align=\"center\"\u003e\n\u003cdiv style=\"padding: 1.5rem; border-radius: 8px; margin: 1rem 0; border: 1px solid #30363d;\"\u003e\n\u003cspan style=\"font-size: 23px;\"\u003e💚\u003c/span\u003e\n\u003ch3 style=\"margin: 1rem 0;\"\u003eCTRF tooling is open source and free to use\u003c/h3\u003e\n\u003cp style=\"font-size: 16px;\"\u003eYou can support the project with a follow and a star\u003c/p\u003e\n\n\u003cdiv style=\"margin-top: 1.5rem;\"\u003e\n\u003ca href=\"https://github.com/ctrf-io/jira-test-reporter\"\u003e\n\u003cimg src=\"https://img.shields.io/github/stars/ctrf-io/jira-test-reporter?style=for-the-badge\u0026color=2ea043\" alt=\"GitHub stars\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/ctrf-io\"\u003e\n\u003cimg src=\"https://img.shields.io/github/followers/ctrf-io?style=for-the-badge\u0026color=2ea043\" alt=\"GitHub followers\"\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n\u003c/div\u003e\n\n\u003cp style=\"font-size: 14px; margin: 1rem 0;\"\u003e\n\nContributions are very welcome! \u003cbr/\u003e\nExplore more \u003ca href=\"https://www.ctrf.io/integrations\"\u003eintegrations\u003c/a\u003e \u003cbr/\u003e\n\u003ca href=\"https://app.formbricks.com/s/cmefs524mhlh1tl01gkpvefrb\"\u003eLet us know your thoughts\u003c/a\u003e.\n\n\u003c/p\u003e\n\u003c/div\u003e\n\n## Features\n\n- **Create Issue in Jira**: Automatically create an issue in Jira.\n- **Send Flaky Test Details to Jira**: Automatically send flaky test details to a Jira issue.\n- **Conditional Notifications**: Use the `--onFailOnly` option to send notifications only if tests fail.\n\n![Example view](assets/issue.png)\n\n## Setup\n\nYou'll need a CTRF report generated by your testing framework. [CTRF reporters](https://github.com/orgs/ctrf-io/repositories) are available for most testing frameworks and easy to install.\n\n**No CTRF reporter? No problem!**\n\nUse [junit-to-ctrf](https://github.com/ctrf-io/junit-to-ctrf) to convert a JUnit report to CTRF.\n\n### Set the Environment Variable\n\nSet the webhook URL as an environment variable in your shell or CI environment:\n\n```sh\nexport JIRA_URL='https://your-domain.atlassian.net'\nexport JIRA_EMAIL='your-email@example.com'\nexport JIRA_API_TOKEN='your-jira-api-token'\n```\n\nMake sure to replace `'https://your-domain.atlassian.net'` with your actual Jira URL.\n\nYou might want to store these as secrets in your CI environment.\n\n## Required Arguments\n\n- `project`: The Jira project key.\n- `issueTypeId`: The Jira issue type. [More info](https://confluence.atlassian.com/jirasoftwarecloud/finding-the-issue-type-id-in-jira-cloud-1333825937.html)\n\n## Usage\n\nYou can use a glob pattern or a single file path to send the test results summary to Jira.\n\n### Results\n\nTo send the test results summary to Jira:\n\n```sh\nnpx jira-ctrf results /path/to/ctrf-report.json --project CCS --issueTypeId 10000\n```\n\nYou can use a glob pattern with multiple files which will be merged together:\n\n```sh\nnpx jira-ctrf results \"ctrf/*.json\" --project CCS --issueTypeId 10000\n```\n\n### Flaky\n\nTo send flaky test report to Jira:\n\n```sh\nnpx jira-ctrf flaky /path/to/ctrf-report.json --project CCS --issueTypeId 10000\n```\n\n### Send Only on Failures\n\nTo send the test results summary to Jira only if there are failed tests, use the `--onFailOnly` option:\n\n```sh\nnpx jira-ctrf results /path/to/ctrf-file.json --onFailOnly --project CCS --issueTypeId 10000\n```\n\n### Custom Notification Title\n\nYou can choose a custom title for your notification, use the `--title` option:\n\n```sh\nnpx jira-ctrf results /path/to/ctrf-file.json --title \"Custom Title\" --project CCS --issueTypeId 10000\n```\n\n## Options\n\n| Option         | Description                                                                                                                | Default                |\n| -------------- | -------------------------------------------------------------------------------------------------------------------------- | ---------------------- |\n| `title`        | Custom title for the Jira issue                                                                                            | \"Test Results Summary\" |\n| `prefix`       | Text to add before the test results                                                                                        | \"\"                     |\n| `suffix`       | Text to add after the test results                                                                                         | \"\"                     |\n| `onFailOnly`   | Only create Jira issues when tests fail                                                                                    | false                  |\n| `project`      | Jira project key                                                                                                           | \"\"                     |\n| `issueTypeId`  | Jira issue type ID                                                                                                         | undefined              |\n| `labels`       | Labels to add to the Jira issue                                                                                            | []                     |\n| `components`   | Components to add to the Jira issue                                                                                        | []                     |\n| `assignee`     | Username of the person to assign the Jira issue to                                                                         | undefined              |\n| `priority`     | Priority of the Jira issue                                                                                                 | undefined              |\n| `fixVersions`  | Comma-separated list of fix versions to add to the Jira issue                                                              | []                     |\n| `tableHeaders` | Comma-separated list of table headers to include (tests,passed,failed,skipped,pending,other,flaky,duration)                | All headers            |\n| `debug`        | Enable debug mode to see the payload being sent to Jira                                                                    | false                  |\n\n## Merge reports\n\nIf you use a glob pattern, the reports will be merged automatically.\n\nOtherwise, the [ctrf-cli](https://github.com/ctrf-io/ctrf-cli) package provides a method to merge multiple ctrf json files into a single file.\n\nAfter executing your tests, use the following command:\n\n```sh\nnpx ctrf merge \u003cdirectory\u003e\n```\n\nReplace directory with the path to the directory containing the CTRF reports you want to merge.\n\n## Programmatic Usage\n\nYou can use the package programmatically to send notifications to Jira. To install the package, run:\n\n```sh\nnpm install jira-ctrf\n```\n\nThe package exports the following functions:\n\n- `sendTestResultsToJira`\n- `sendFlakyResultsToJira`\n\n```ts\nimport { sendTestResultsToJira } from 'jira-ctrf'\n\nsendTestResultsToJira(report)\n```\n\n## What is CTRF?\n\nCTRF is a universal JSON test report schema that addresses the lack of a standardized format for JSON test reports.\n\n**Consistency Across Tools:** Different testing tools and frameworks often produce reports in varied formats. CTRF ensures a uniform structure, making it easier to understand and compare reports, regardless of the testing tool used.\n\n**Language and Framework Agnostic:** It provides a universal reporting schema that works seamlessly with any programming language and testing framework.\n\n**Facilitates Better Analysis:** With a standardized format, programatically analyzing test outcomes across multiple platforms becomes more straightforward.\n\n## Support Us\n\nIf you find this project useful, consider giving it a GitHub star ⭐ It means a lot to us.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctrf-io%2Fjira-test-reporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fctrf-io%2Fjira-test-reporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctrf-io%2Fjira-test-reporter/lists"}