Skip to content

Commit

Permalink
docs: add visual overview
Browse files Browse the repository at this point in the history
  • Loading branch information
Ma11hewThomas committed Oct 31, 2024
1 parent 08a2abd commit 6c69b75
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,19 @@ Thank you! Your support is invaluable to us! 💙
## Key Features

- **Seamless Test Result Integration:** View and publish test results directly within the GitHub Actions workflow summary.
- **Automated PR Comments:** Post detailed test results as comments on GitHub Pull Requests automatically, enhancing team collaboration and code review efficiency.
- **Automated PR Comments:** Post any views as as comments on GitHub Pull Requests automatically, including custom.
- **Many View Options:** Access a variety of views, including Test Summary, Historical, Detailed Test Results, Failed Tests Overview, and Flaky Tests Analysis.
- **View AI summaries**: View AI generated summaries to help resolve failed tests.
- **Customizable Reports:** Build and customize your own test summary reports to fit specific project requirements.
- **Broad Framework Support:** Compatible with all major testing frameworks through standardized CTRF reports.
- **Easy Setup and Use:** Run the tool with a simple command: npx github-actions-ctrf your-report.json.
- **Merge Multiple Test Reports:** If your framework generates multiple reports, merge them into a single report.

## Example
## Visual Overview

![Example view](images/all.png)
| ![all](images/all.png) | ![historical](images/historical.png) | ![flaky-rate](images/flaky-rate.png) | ![ai](images/ai.png) | ![pr](images/pr.png) |
|:--:|:--:|:--:|:--:|:--:|
| ![suite-folded](images/suite-folded.png) | ![failed-folded](images/failed-folded.png) | ![custom](images/custom.png) | ![failed](images/failed.png) | ![annotations](images/annotations.png) |

## Usage

Expand Down
Binary file added images/annotations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/custom.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/failed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6c69b75

Please sign in to comment.