docs: extra info for test_compose to retain coverage files

hotosm · Jan 23, 2024 · d4a070a · d4a070a
1 parent b29f014
commit d4a070a
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/test_compose.md b/docs/test_compose.md
@@ -136,6 +136,13 @@ services:
       retries: 3
 ```
 
+### Coverage files are overwritten
+
+- If you run this workflow, then the mkdocs_build workflow directly
+  afterwards, the coverage files may get overwritten.
+- To solve this, add the `keep_extra_files` variable to the mkdocs_build
+  workflow to retain the `coverage.html` and `coverage.svg` badge.
+
 ## Inputs
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->