Deactivate code analysis

.github/workflows/codeql-analysis.yml → .github/workflows/_codeql-analysis.yml

@@ -1,14 +1,14 @@
 name: CodeQL
 
 on:
-  pull_request:
-    branches:
-      - main
-  push:
-    branches:
-      - main
-  schedule:
-    - cron: '31 7 * * 3'
+  # pull_request:
+  #   branches:
+  #     - main
+  # push:
+  #   branches:
+  #     - main
+  # schedule:
+  #   - cron: '31 7 * * 3'
 
 permissions:
   actions: read

README.md

@@ -19,13 +19,43 @@ or run output.
   with:
     lcov-file: './coverage/lcov.info'
     excluded-files: '**/*.g.dart, **/*.freezed.dart, **/.realm.dart'
+
+- name: Coverage output
+  run: |
+    echo "${{ steps.lcov-result.outputs.coverage }}"
+    echo "${{ steps.lcov-result.outputs.markdown-table }}"
 ```
 
 ### Configuration parameters
 
+#### `lcov-file`
+
+Path to the lcov file to parse (currently only one file supported).
+
+#### `excluded-files`
+
+Comma separated list of files, that should be excluded from code coverade report. Common globes can be used here:
+
+- `**`: folder globe (e.g. `**/email.dart` would match `foo/email.dart` but also `foo/bar/foo-bar/email.dart`)
+- `*`: file name globe (e.g. `**/email-*-validation.dart` would match `email-domain-validation.dart` but not `emailvalidation.dart`)
+
+### Overall coverage result
+
+22.83
+
+### Mardown Table result
+
+| File | Line Coverage | Function Coverage | Branch Coverage |
+| --- | --- | --- | --- |
+| lib/domain/models/email.dart | 100.00% | 0.00% | 0.00% |
+| lib/core/exceptions/exceptions.dart | 40.00% | 0.00% | 0.00% |
+
 ## TODO
 
 - [x] Parse lcov file, so it is easier to handle the results
 - [x] Provide following outputs
   - Markdown table with code coverage per test file
   - Overall coverage
+- [ ] Add possibility to "comment" on PR
+- [ ] Add possibility for run output
+- [ ] Add templates