fix(UX-1139): Prevent commiting coverage file; store previous coverage result as artifact (#25)

feat: Add `run-prev-coverage` flag
chore: Add debug logs
Release-as: 1.0.6

Author: thelukewalton

README.md

@@ -35,10 +35,23 @@ jobs:
 | run-tests         | Whether tests should be run.                                      | false    | true    |
 | run-analysis      | Whether static analysis should be run.                            | false    | true    |
 | run-coverage      | Whether code coverage should be run.                              | false    | true    |
+| run-prev-coverage | Whether code coverage should be compared with the base branch.    | false    | true    |
 | run-behind-by     | Whether action should check if HEAD branch is behind base branch. | false    | true    |
 | create-comment    | Whether the action should comment the output status.              | false    | true    |
 | working-directory | Working directory to run the action in                            | false    | "."     |
 
+## Coverage
+
+⚠️ To compare coverage against previous code, it is required that the code is checked out with `fetch-depth: 0`:
+
+```yaml
+- uses: actions/checkout@v4
+    with:
+      fetch-depth: 0
+```
+
+> During the action, coverage will be calculated, and lcov.info will be saved in temporary directory `.coverage`. Please refrain from using a top level directory with this path, as this could cause issues.
+
 ## Contributing
 
 This project welcomes contributions. Please check out our [Contributing guide](CONTRIBUTING.md) to learn more on how to get started.

action.yml

@@ -33,6 +33,12 @@ inputs:
     default: true
     type: boolean
 
+  run-prev-coverage:
+    description: "Run test coverage check on base branch"
+    required: false
+    default: true
+    type: boolean
+
   run-behind-by:
     description: "Run behind by check"
     required: false