Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme with summary option and example #270

Merged
merged 1 commit into from
Apr 15, 2022
+16 −4
Merged

Update readme with summary option and example #270

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,9 @@ Options:
--bucket=VALUE # Bucket name. Required: true
--prefix=VALUE # Optional prefix for report path. Required: false
--update-pr=VALUE # Add report url to PR via comment or description update. Required: false: (comment/description)
--summary=VALUE # Additionally add summary table to PR comment or description. Required: false: (behaviors/suites/packages/total)
--[no-]copy-latest # Keep copy of latest report at base prefix path, default: false
--[no-]color # Toggle color output, default: false
--[no-]color # Force color output
--[no-]ignore-missing-results # Ignore missing allure results, default: false
--help, -h # Print this help

Expand Down Expand Up @@ -104,19 +105,30 @@ Following CI providers are supported:

## Pull requests

It is possible to update pull requests with urls to published reports.
It is possible to update pull requests with urls to published reports and execution summary.

- `--update-pr=(comment|description)`: post report urls in pr description or as a comment
- `--summary=(behaviors/suites/packages/total)`: add execution summary table

Example:

---

`# Allure report`

`allure-report-publisher` generated test report for [1b756f48](https://github.com/andrcuns/allure-report-publisher/commit/HEAD)!
`allure-report-publisher` generated test report!

**rspec**: 📝 [test report](https://storage.googleapis.com/allure-test-reports/allure-report-publisher/refs/heads/main/index.html)
**rspec**: ✅ [test report](https://storage.googleapis.com/allure-test-reports/allure-report-publisher/refs/heads/main/index.html) for [1b756f48](https://github.com/andrcuns/allure-report-publisher/commit/HEAD)

```markdown
+--------------------------------------------------------+
| total summary |
+-----------+--------+--------+---------+-------+--------+
| | passed | failed | skipped | flaky | result |
+-----------+--------+--------+---------+-------+--------+
| Total | 100 | 0 | 2 | 0 | ✅ |
+-----------+--------+--------+---------+-------+--------+
```

---

Expand Down