Setup Github CI

.github/workflows/main.yml

@@ -0,0 +1,63 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Tests & Coverage
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [ ci ]
+
+  pull_request:
+    branches: [ ci ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  # Label of the container job
+  tests-run:
+    # Containers must run in Linux based operating systems
+    runs-on: ubuntu-latest
+    # Docker Hub image that `container-job` executes in
+    container: node:10.18-jessie
+
+    # Service containers to run with `container-job`
+    services:
+      # Label used to access the service container
+      redis:
+        # Docker Hub image
+        image: redis
+        # Set health checks to wait until redis has started
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      # Downloads a copy of the code in your repository before running CI tests
+      - name: Check out repository code
+        uses: actions/checkout@v2
+
+      # Performs a clean installation of all dependencies in the `package.json` file
+      # For more information, see https://docs.npmjs.com/cli/ci.html
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Check type coverage
+        run: npm run type-coverage
+
+      - name: Run tests
+        run: npm test
+        env:
+          # The hostname used to communicate with the Redis service container
+          REDIS_HOST: redis
+          # The default Redis port
+          REDIS_PORT: 6379
+
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+        if: success()

.gitignore

@@ -1,7 +1,6 @@
 # compiled output
 /dist
 /node_modules
-/docs/coverage
 
 # Logs
 logs

.npmignore

@@ -1,5 +1,4 @@
 dist/tests
-docs/coverage
 examples
 src/**
 tests/**
@@ -11,4 +10,6 @@ index.ts
 tsconfig.json
 jest.config.js
 .idea
-types/**
+types/**
+coverage/**
+.github/**

README.md

@@ -1,5 +1,9 @@
 # RedisSMQ - Yet another simple Redis message queue
 
+![example workflow](https://github.com/weyoss/redis-smq/actions/workflows/main/badge.svg)
+![Coverage Status](https://coveralls.io/repos/weyoss/redis-smq/badge.svg?branch=ci)
+
+
 A simple high-performance Redis message queue for Node.js.
 
 For more details about RedisSMQ design see [https://medium.com/@weyoss/building-a-simple-message-queue-using-redis-server-and-node-js-964eda240a2a](https://medium.com/@weyoss/building-a-simple-message-queue-using-redis-server-and-node-js-964eda240a2a)

jest.config.js

@@ -7,6 +7,6 @@ module.exports = {
   rootDir: path.resolve('./'),
   testMatch: ['**/dist/**/*.test.js'],
   setupFilesAfterEnv: ['<rootDir>/dist/tests/jest.setup.js'],
-  coverageDirectory: '<rootDir>/docs/coverage',
+  coverageDirectory: '<rootDir>/coverage',
   collectCoverage: true,
 };