Skip to content

Commit 3834009

Browse files
marcosbogerionelmc
authored andcommitted
Add GitHub Actions example and fix example to not break with default markdown files
1 parent 0824728 commit 3834009

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/reporting.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,14 @@ The report options below output to files without showing anything on the termina
5555
--cov-report xml
5656
--cov-report json
5757
--cov-report markdown
58-
--cov-report markdown-append
58+
--cov-report markdown-append:cov-append.md
5959
--cov-report lcov
6060
--cov-report annotate
6161
--cov=myproj tests/
6262

6363
The output location for each of these reports can be specified. The output location for the XML, JSON, Markdown and LCOV
64-
report is a file. Where as the output location for the HTML and annotated source code reports are
64+
report is a file. markdown-append option is specially useful for appending the report to an existing file. Example for GitHub Actions:
65+
--cov-report=markdown-append:${GITHUB_STEP_SUMMARY}. Where as the output location for the HTML and annotated source code reports are
6566
directories::
6667

6768
pytest --cov-report html:cov_html

0 commit comments

Comments
 (0)