Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moeh-jama/webhook-reporter
Github Actions Coverage reporter. Sends to Provider (discord, slack, microsoft teams) via given webhook
https://github.com/moeh-jama/webhook-reporter
alert alerting alerting-service cicd coverage coverage-report discord github-actions notification notifications observability slack teams test-automation webhook
Last synced: about 1 month ago
JSON representation
Github Actions Coverage reporter. Sends to Provider (discord, slack, microsoft teams) via given webhook
- Host: GitHub
- URL: https://github.com/moeh-jama/webhook-reporter
- Owner: Moeh-Jama
- License: mit
- Created: 2024-08-22T14:45:54.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-12-26T18:37:01.000Z (about 1 month ago)
- Last Synced: 2024-12-26T19:25:07.494Z (about 1 month ago)
- Topics: alert, alerting, alerting-service, cicd, coverage, coverage-report, discord, github-actions, notification, notifications, observability, slack, teams, test-automation, webhook
- Language: Python
- Homepage:
- Size: 299 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Webhook Reporter 🕵️
Seamlessly send test reports to your preferred messaging platforms.
## Overview 📋
Webhook Reporter is a versatile GitHub Action designed to generate and send detailed test coverage and test result reports to multiple messaging platforms. It seamlessly parses coverage and test result data, standardizes the reports, and delivers them through webhooks to platforms such as Discord, Slack, or Microsoft Teams.
### Why Webhook Reporter? 🤔
Development teams rely on test coverage and results to maintain code quality and catch issues early. However, this critical data often stays buried in CI/CD logs or requires team members to actively check dashboards. Webhook Reporter solves this by:
- 💬 **Bringing insights where teams collaborate**: Automatically delivers test results and coverage metrics directly to Slack, Discord, or Microsoft Teams - where your team already works
- ⚠️ **Maintaining code quality standards**: Instantly alerts teams when coverage drops below thresholds or tests fail, enabling quick responses to potential issues
- 📊 **Simplifying complex data**: Transforms various test report formats (Cobertura, JaCoCo, Clover) into clear, actionable summaries
- ✅ **Supporting confident releases**: Provides immediate visibility into test health across your codebase after each commit or PR
- ⏳ **Saving developer time**: Eliminates manual checking of coverage reports and test results across different tools and formats
## Features ✨
- Supports multiple platforms: Discord, Slack, Microsoft Teams
- Parses test results and coverage data: Compatible with JaCoCo, Cobertura, Clover, etc.
- Generates unified reports: Combines test results and coverage into a single output.
- Easy integration: Works with any GitHub Actions workflow.
### Examples
Discord
Slack
Teams
Test and coverage summary delivered to Discord
Test and coverage summary delivered to Slack
Test and coverage summary delivered to Teams
## Configuration Details ⚙️
### Usage
To use this action in your workflow add it like so:
```yaml
steps:
- name: Webhook Reporter
uses: your-username/[email protected]
with:
webhook_url: ${{ secrets.WEBHOOK_URL }}
provider: 'discord' # 'discord', 'slack', or 'teams'
coverage_file: 'path/to/coverage.xml'
test_results_file: 'path/to/test-results.xml'
# This action will parse the provided files and send a report to the specified webhook URL. Ensure the files are generated before this step.
# If any file is missing or an error occurs during processing, the action will log the issue for troubleshooting.
```
> **Note:** 🔒 Ensure your webhook URL is stored securely as a GitHub Secret (e.g., `WEBHOOK_URL`).
### Parameter Arguements
| Input | Description | Required | Default |
|---------------------|------------------------------------------------------------------|----------|---------|
| `webhook_url` | Webhook URL for the target messaging platform | Yes | N/A |
| `provider` | Messaging platform (`discord`, `slack`, `teams`) | Yes | N/A |
| `coverage_file` | Path to the coverage report (e.g., `coverage.xml`) | Yes | N/A |
| `test_results_file` | Path to the test results report (e.g., `test-results.xml`) | No | N/A |
| `coverage_threshold`| The coverage threshold you want to mark against your tests | No | N/A |
## Framework Setup & Compatibility 🔧
Webhook Reporter works with any testing framework that produces standard coverage and test result formats. For comprehensive insights into your project's health, we'll help you generate both coverage and test results files.
### Supported Report Formats 🗂️
#### Coverage Reports
| Format | Description | Common Frameworks |
|--------|-------------|-------------------|
| Cobertura XML | Industry-standard coverage format | Pytest, Jest, .NET |
| JaCoCo XML | Java-ecosystem coverage format | Java frameworks using JaCoCo |
| Clover XML | Alternative coverage format | Jest, PHP frameworks |
#### Test Results
| Format | Description | Common Frameworks |
|--------|-------------|-------------------|
| JUnit XML | Universal test result format | Most testing frameworks |
| JSON | Modern test output format | Jest, modern JavaScript frameworks |
### Framework Configuration 🛠️
JavaScript (Jest)
### Installation
First, install the necessary dependencies:
```bash
npm install --save-dev jest-junit
```
### Configuration
Add to your `package.json`:
```json
"jest-junit": {
"outputDirectory": "./test-results",
"outputName": "test-results.xml"
}
```
### Usage
```bash
jest --coverage --coverageReporters=cobertura --testResultsProcessor=jest-junit
```
This generates:
- Coverage report: `coverage/cobertura-coverage.xml`
- Test results: `test-results/test-results.xml`
### Alternative Coverage Format
Jest can also output coverage in Clover format:
```bash
jest --coverage --coverageReporters=clover
```
> **Note:** You only need either Cobertura OR Clover format - pick the one that best suits your needs.
Python (Pytest)
### Installation
```bash
pip install pytest-cov pytest-junit
```
### Usage
```bash
pytest --cov=your_package --cov-report=xml:coverage.xml --junitxml=test-results.xml
```
This command:
- Runs pytest with coverage enabled
- Generates Cobertura-compatible coverage report (`coverage.xml`)
- Outputs test results in JUnit format (`test-results.xml`)
The command will handle both coverage generation and test results output in formats that Webhook Reporter can process.
Java (JaCoCo)
Configure your Maven build tool for JaCoCo as follows:
```xml
org.jacoco
jacoco-maven-plugin
0.8.7
prepare-agent
report
test
report
```
For test results, add the Surefire plugin:
```xml
org.apache.maven.plugins
maven-surefire-plugin
3.0.0-M5
true
```
### Usage
```bash
mvn clean test
```
This will generate:
- Coverage report in JaCoCo's native XML format: `target/site/jacoco/jacoco.xml`
- Test results in JUnit format: `target/surefire-reports/TEST-*.xml`
.NET (Cobertura)
### Installation
```bash
dotnet add package coverlet.collector
```
### Usage
```bash
dotnet test /p:CollectCoverage=true /p:CoverletOutputFormat=cobertura
```
This generates:
- Coverage report in Cobertura format: `coverage.cobertura.xml`
- Test results are typically generated in the Visual Studio Test Platform's TRX format
Other Frameworks
Your framework should output one of these formats:
- Coverage: Cobertura XML, JaCoCo XML, or Clover XML
- Test Results: JUnit XML or JSON
Many frameworks can output to these formats through plugins or configuration. If your framework doesn't support these formats directly, consider:
1. Looking for coverage/reporting plugins that support these formats
2. Using a format converter tool
3. Creating a custom reporter that outputs in one of the supported formats
## Contributing 💡
see: [Contribution.md](https://github.com/Moeh-Jama/webhook-reporter/blob/main/Contributions.md)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.