Add base cicd configuration

Author: Fabrice Bascoulergue

.github/workflows/cd.yml

@@ -0,0 +1,52 @@
+name: CD
+
+on:
+  push:
+    tags:
+      - "v*" # Push events to matching v*, i.e. v1.0, v20.15.10
+
+jobs:
+  build:
+    name: Release & Publish
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x]
+        redis-version: [5]
+
+    env:
+      CLOUDSDK_CORE_PROJECT: dev
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: yarn --frozen-lockfile
+      - name: Run code formatter
+        run: yarn format
+      - name: Run code linter
+        run: yarn lint
+      - name: Run unit tests
+        run: yarn test
+
+      - name: Run build lib, types and docs
+        run: yarn build
+      - name: Copy LICENSE
+        run: cp LICENSE lib/LICENSE
+      - name: Copy README
+        run: cp README.md lib/README.md
+      - name: Copy sanitized package.json
+        run: cp package.json lib/package.json
+      - name: Publish package to NPM
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - master
+      - develop
+
+jobs:
+  build:
+    name: Format Lint Test Build
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x, 15.x]
+        redis-version: [4, 5, 6]
+
+    env:
+      CLOUDSDK_CORE_PROJECT: dev
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: yarn --frozen-lockfile
+      - name: Run code formatter
+        run: yarn format
+      - name: Run code linter
+        run: yarn lint
+      - name: Run unit tests
+        run: yarn test
+      - name: Run build lib, types and docs
+        run: yarn build

README.md

@@ -1,10 +1,10 @@
-# Sandblock Chain - Javascript SDK
+# Lum Network - Javascript SDK
 
-This Javascript SDK enables browsers and NodeJS clients to interact with the Sandblock Chain.
+This Javascript SDK enables browsers and NodeJS clients to interact with the Lum Network.
 
 ## SDK Features
 
-This SDK basically provides an easy access to all the available Sandblock Chain RPCs as well as the payload generation and the cryptographic features to properly consume those RPCs.
+This SDK basically provides an easy access to all the available Lum Network blockchain RPCs as well as the payload generation and the cryptographic features to properly consume those RPCs.
 
 **Most commonly used features:**
 

package.json

@@ -1,20 +1,34 @@
 {
-    "name": "@sandblock-chain/sdk-javascript",
-    "version": "1.0.0",
+    "name": "@lum-network/sdk-javascript",
+    "version": "0.1.0",
     "license": "Apache-2.0",
+    "description": "Javascript SDK library for NodeJS and Web browsers to interact with the Lum Network.",
+    "homepage": "https://github.com/lum-network/sdk-javascript#readme",
+    "bugs": {
+        "url": "https://github.com/lum-network/sdk-javascript/issues"
+    },
+    "author": {
+        "name": "Lum Network"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/lum-network/sdk-javascript.git"
+    },
     "main": "lib/index.js",
     "typings": "lib/index.d.ts",
     "files": [
         "lib/*"
     ],
     "scripts": {
         "test": "cross-env NODE_ENV=test jest",
-        "build": "yarn clean && yarn build:types && yarn build:js",
+        "build": "yarn clean && yarn build:types && yarn build:js && yarn build:docs",
         "build:types": "tsc --emitDeclarationOnly",
         "build:js": "babel src --out-dir lib --extensions \".ts,.tsx\" --source-maps inline",
+        "build:docs": "rimraf docs/lib && typedoc --excludeExternals --excludeNotDocumented --readme none --out docs/lib --hideBreadcrumbs --disableSources",
         "clean": "rimraf lib",
         "lint": "eslint '**/*.{ts,js}'",
-        "format": "prettier --write '**/*.{js,jsx,ts,tsx,css,json,md,html,yml}'"
+        "format": "prettier --write '**/*.{js,jsx,ts,tsx,css,json,md,html,yml}'",
+        "bump": "npm version"
     },
     "dependencies": {},
     "optionalDependencies": {},
@@ -33,6 +47,8 @@
         "prettier": "^2.2.1",
         "rimraf": "^3.0.2",
         "ts-jest": "^26.5.0",
+        "typedoc": "^0.20.25",
+        "typedoc-plugin-markdown": "^3.5.0",
         "typescript": "^4.1.3"
     }
 }