Skip to content

Commit 5204391

Browse files
authored
Update README.md
Clarify the need for ".coverage." prefix
1 parent 3d4662c commit 5204391

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,15 +258,21 @@ jobs:
258258
run: make test # This is the part where you put your own test command
259259
env:
260260
COVERAGE_FILE: ".coverage.${{ matrix.python_version }}"
261+
# The file name prefix must be ".coverage." for "coverage combine"
262+
# enabled by "MERGE_COVERAGE_FILES: true" to work. A "subprocess"
263+
# error with the message "No data to combine" will be triggered if
264+
# this prefix is not used.
261265
262266
- name: Store coverage file
263267
uses: actions/upload-artifact@v4
264268
with:
265269
name: coverage-${{ matrix.python_version }}
266270
path: .coverage.${{ matrix.python_version }}
267271
# By default hidden files/folders (i.e. starting with .) are ignored.
268-
# You may prefer (for security reason) not setting this and instead
269-
# set COVERAGE_FILE above to not start with a `.`
272+
# You may prefer (for security reasons) not setting this and instead
273+
# set COVERAGE_FILE above to not start with a `.`, but you cannot
274+
# use "MERGE_COVERAGE_FILES: true" later on and need to manually
275+
# combine the coverage file using "pipx run coverage combine"
270276
include-hidden-files: true
271277

272278
coverage:

0 commit comments

Comments
 (0)