From a5a006eee4e77f75c1502b8771a6fe64bd133fcf Mon Sep 17 00:00:00 2001 From: Dario Curreri <48800335+dariocurr@users.noreply.github.com> Date: Tue, 2 May 2023 21:12:20 +0200 Subject: [PATCH] Update README (#13) * Update test-summary/action to v2.1 * update README to test-summary v2 * fix whitespaces * add example to README --------- Co-authored-by: Nils Uhrberg --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 6e9bbef..d0bb395 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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