Merge pull request #2 from dillonstreator/codecov

codecov

.github/workflows/coverage.yml

@@ -0,0 +1,36 @@
+name: Running Code Coverage
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Set up Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - name: Install dependencies
+      run: yarn install
+
+    - name: Remove example dir
+      run: |
+        rm -rf example
+
+    - name: Run the tests
+      run: yarn test:ci
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v2
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -1,3 +1,19 @@
-# txob
-
-generic transactional outbox event processor
+<h1 align="center">txob</h1>
+<p align="center">A generic transactional outbox event processor</p>
+<p align="center">
+  <a href="https://codecov.io/gh/dillonstreator/txob" >
+    <img src="https://codecov.io/gh/dillonstreator/txob/graph/badge.svg?token=E9M7G67VLL"/>
+  </a>
+  <a aria-label="NPM version" href="https://www.npmjs.com/package/txob">
+    <img alt="" src="https://badgen.net/npm/v/txob">
+  </a>
+  <a aria-label="License" href="https://github.com/dillonstreator/txob/blob/main/LICENSE">
+    <img alt="" src="https://badgen.net/npm/license/txob">
+  </a>
+  <a aria-label="Typescript" href="https://github.com/dillonstreator/txob/blob/main/src/cache.ts">
+    <img alt="" src="https://badgen.net/npm/types/txob">
+  </a>
+  <a aria-label="CodeFactor" href="https://www.codefactor.io/repository/github/dillonstreator/txob">
+    <img alt="" src="https://www.codefactor.io/repository/github/dillonstreator/txob/badge">
+  </a>
+</p>

package.json

@@ -37,7 +37,8 @@
     "prepublish": "yarn build",
     "clean": "rimraf dist",
     "nuke": "rimraf node_modules dist",
-    "test": "vitest"
+    "test": "vitest",
+    "test:ci": "yarn test --run --coverage"
   },
   "dependencies": {
     "pg": "^8.11.3",