{"id":20137076,"url":"https://github.com/ctrf-io/microsoft-teams-test-reporter","last_synced_at":"2025-04-09T17:50:21.600Z","repository":{"id":242585020,"uuid":"809970280","full_name":"ctrf-io/microsoft-teams-test-reporter","owner":"ctrf-io","description":"Send MS Teams notifications with test results from popular testing frameworks using a single command in your CI/CD","archived":false,"fork":false,"pushed_at":"2025-02-16T19:27:55.000Z","size":114,"stargazers_count":7,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-23T19:51:21.703Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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}},"created_at":"2024-06-03T19:55:52.000Z","updated_at":"2025-02-16T19:27:58.000Z","dependencies_parsed_at":"2024-06-20T05:21:38.141Z","dependency_job_id":"19f57333-8982-45df-ac2f-55f2b72cb8ea","html_url":"https://github.com/ctrf-io/microsoft-teams-test-reporter","commit_stats":null,"previous_names":["ctrf-io/teams-ctrf","ctrf-io/microsoft-teams-test-reporter"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctrf-io%2Fmicrosoft-teams-test-reporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctrf-io%2Fmicrosoft-teams-test-reporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctrf-io%2Fmicrosoft-teams-test-reporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctrf-io%2Fmicrosoft-teams-test-reporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ctrf-io","download_url":"https://codeload.github.com/ctrf-io/microsoft-teams-test-reporter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248082797,"owners_count":21044977,"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":[],"created_at":"2024-11-13T21:25:04.697Z","updated_at":"2025-04-09T17:50:21.594Z","avatar_url":"https://github.com/ctrf-io.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Teams Test Results Notification\n\n\u003e Send Microsoft Teams message with test result from popular testing frameworks\n\nA Microsoft Teams test reporting tool that supports all major testing frameworks. Generate, publish and alert your team with detailed test results, including summaries, in-depth reports, flaky test detection and AI analyses directly to your chosen Teams channel.\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/microsoft-teams-test-reporter\"\u003e\n\u003cimg src=\"https://img.shields.io/github/stars/ctrf-io/microsoft-teams-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\nMaintained by \u003ca href=\"https://github.com/ma11hewthomas\"\u003eMatthew Thomas\u003c/a\u003e\u003cbr/\u003e\nContributions are very welcome! \u003cbr/\u003e\nExplore more \u003ca href=\"https://www.ctrf.io/integrations\"\u003eintegrations\u003c/a\u003e\n\u003c/p\u003e\n\u003c/div\u003e\n\n## Features\n\n- **Send Test Results to Teams**: Automatically send test results to a Teams channel.\n- **Send Flaky Test Details to Teams**: Automatically send flaky test details to a Teams channel.\n- **Send AI generated Failed Test Summary to Teams**: Automatically send AI summary to a Teams channel.\n- **Conditional Notifications**: Use the `--onFailOnly` option to send notifications only if tests fail.\n\n![Example view](assets/results.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### Create a Teams Incoming Webhook\n\nSetup an incoming webhook by following instructions on [Teams documentation](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook?tabs=newteams%2Cdotnet)\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 TEAMS_WEBHOOK_URL='https://hooks.teams.com/services/your/webhook/url'\n```\n\nMake sure to replace `'https://hooks.teams.com/services/your/webhook/url'` with your actual webhook URL.\n\nYou might want to store the webhook URL as a secret.\n\n## Usage\n\nTo send the test results summary to Teams:\n\n```sh\nnpx teams-ctrf results /path/to/ctrf-report.json\n```\n\n![Results view](assets/results.png)\n\nTo send flaky test report to Teams:\n\n```sh\nnpx teams-ctrf flaky /path/to/ctrf-report.json\n```\n\n![Flaky view](assets/flaky.png)\n\nTo send ai test summary for failed tests to Teams:\n\n```sh\nnpx teams-ctrf ai /path/to/ctrf-report.json\n```\n\n### Send Only on Failures\n\nTo send the test results summary to Teams only if there are failed tests, use the `--onFailOnly` option:\n\n```sh\nnpx teams-ctrf results /path/to/ctrf-file.json --onFailOnly\n```\n\nor using the alias:\n\n```sh\nnpx teams-ctrf results /path/to/ctrf-file.json -f\n```\n\n## Options\n\n- `--onFailOnly, -f`: Send notification only if there are failed tests.\n\n## Merge reports\n\nYou can merge reports if your chosen reporter generates multiple reports through design, parallelisation or otherwise.\n\nThe [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## 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%2Fmicrosoft-teams-test-reporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fctrf-io%2Fmicrosoft-teams-test-reporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctrf-io%2Fmicrosoft-teams-test-reporter/lists"}