Merge pull request #3 from StevanFreeborn/fix/update-documentation

fix: update documentation

Author: StevanFreeborn

.github/workflows/build_publish.yml

@@ -52,6 +52,10 @@ jobs:
           TEST_SURVEY_ID: ${{ vars.TEST_SURVEY_ID }}
           TEST_SURVEY_RECORD_ID: ${{ vars.TEST_SURVEY_RECORD_ID }}
           TEST_TEXT_FIELD: ${{ vars.TEST_TEXT_FIELD }}
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
       - name: Upload build artifact
         uses: actions/[email protected]
         with:

.github/workflows/lint_format_test.yaml

@@ -113,10 +113,24 @@ jobs:
           TEST_SURVEY_ID: ${{ vars.TEST_SURVEY_ID }}
           TEST_SURVEY_RECORD_ID: ${{ vars.TEST_SURVEY_RECORD_ID }}
           TEST_TEXT_FIELD: ${{ vars.TEST_TEXT_FIELD }}
+      - name: Upload test coverage artifact
+        uses: actions/[email protected]
+        with:
+          name: coverage
+          path: ./coverage
   publish_test_coverage:
     needs: test
     name: publish_test_coverage
     runs-on: ubuntu-latest
     steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+      - name: Download test coverage artifact
+        uses: actions/[email protected]
+        with:
+          name: coverage
+          path: ./coverage
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.husky/commit-msg

@@ -6,8 +6,18 @@
   "functions": 100,
   "statements": 100,
   "all": true,
-  "include": ["src/**/*.ts"],
-  "exclude": ["src/index.ts", "**/*.spec.ts"],
-  "reporter": ["html", "lcov", "text", "text-summary"],
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "src/index.ts",
+    "**/*.spec.ts"
+  ],
+  "reporter": [
+    "html",
+    "lcov",
+    "text",
+    "text-summary"
+  ],
   "report-dir": "coverage"
-}
+}