configs

Author: Nikita Filonov

docs/configs/.env.example

@@ -0,0 +1,23 @@
+# Define the applications that should be tracked. In the case of multiple apps, they can be added in a comma-separated list.
+UI_COVERAGE_APPS='[
+    {
+        "key": "my-ui-app",
+        "url": "https://my-ui-app.com/login",
+        "name": "My UI App",
+        "tags": ["UI", "PRODUCTION"],
+        "repository": "https://github.com/my-ui-app"
+    }
+]'
+
+# The directory where the coverage results will be saved.
+UI_COVERAGE_RESULTS_DIR="./coverage-results"
+
+# The file that stores the history of coverage results.
+UI_COVERAGE_HISTORY_FILE="./coverage-history.json"
+
+# The retention limit for the coverage history. It controls how many historical results to keep.
+UI_COVERAGE_HISTORY_RETENTION_LIMIT=30
+
+# Optional file paths for the HTML and JSON reports.
+UI_COVERAGE_HTML_REPORT_FILE="./index.html"
+UI_COVERAGE_JSON_REPORT_FILE="./coverage-report.json"

docs/configs/ui_coverage_config.json

@@ -0,0 +1,19 @@
+{
+  "services": [
+    {
+      "key": "my-ui-app",
+      "url": "https://my-ui-app.com/login",
+      "name": "My UI App",
+      "tags": [
+        "UI",
+        "PRODUCTION"
+      ],
+      "repository": "https://github.com/my-ui-app"
+    }
+  ],
+  "results_dir": "./coverage-results",
+  "history_file": "./coverage-history.json",
+  "history_retention_limit": 30,
+  "html_report_file": "./index.html",
+  "json_report_file": "./coverage-report.json"
+}

docs/configs/ui_coverage_config.yaml

@@ -0,0 +1,18 @@
+# List of application configurations.
+apps:
+  - key: "my-ui-app"  # Unique identifier for the app.
+    url: "https://my-ui-app.com/login"  # Entry point URL of the app.
+    name: "My UI App"  # Name of the app.
+    tags: [ "UI", "PRODUCTION" ]  # Optional list of tags to describe the application.
+    repository: "https://github.com/my-ui-app"  # Optional URL to the repository of the application.
+
+# Directory where coverage results will be stored.
+results_dir: "./coverage-results"  # This path is relative to the current working directory.
+
+# File where the history of coverage results is saved.
+history_file: "./coverage-history.json"  # This path is relative to the current working directory.
+history_retention_limit: 30  # The maximum number of history records to keep.
+
+# File paths for reports. These are optional, and if not set, reports will not be generated.
+html_report_file: "./index.html"  # Path to the HTML report file.
+json_report_file: "./coverage-report.json"  # Path to the JSON report file.