Skip to content

Commit

Permalink
Update README (#13)
Browse files Browse the repository at this point in the history
* Update test-summary/action to v2.1

* update README to test-summary v2

* fix whitespaces

* add example to README

---------

Co-authored-by: Nils Uhrberg <nils.uhrberg@codecentric.de>
  • Loading branch information
dariocurr and aiakide committed May 2, 2023
1 parent 22b01d9 commit a5a006e
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Run your pytests and produce an easy-to-read summary as part of your GitHub Acti
This helps you understand at-a-glance the impact to the changes in your pull requests, and see which changes are introducing new problems.

Pillars:

* Integrates tests easily with your existing GitHub Actions workflow
* Produces summaries from `pytest` output
* Customizable to show just a summary, just failed tests, or all test results.
Expand Down Expand Up @@ -95,6 +96,12 @@ To specify them correctly, please have a look [here](https://docs.pytest.org). F
* **`show`**: which tests have to be shown in the summary (optional, by default `fail`)
This controls whether a test summary table is created or not, as well as what tests are included. It could be all, none, pass, skip, or fail. The default is fail - that is, the summary table will only show the failed tests. For example, if you wanted to show failed and skipped tests:
```yaml
uses: dariocurr/pytest-summary@main
with:
show: "fail, skip"
```
---
## Upload the markdown
Expand Down

0 comments on commit a5a006e

Please sign in to comment.