Add workflow to build docs

.github/workflows/gh-pages.yml

@@ -0,0 +1,34 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Build docs and deploy
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v2 # If you're using actions/checkout@v2 you must set persist-credentials to false in most cases for the deployment to work correctly.
+        with:
+          persist-credentials: false
+
+      - name: Install SSH Client 🔑
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.DEPLOY_KEY }}
+
+      - name: Install and Build 🔧 
+        run: |
+          npm install
+          npm run build-docs
+
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@releases/v3
+        with:
+          SSH: true
+          BRANCH: gh-pages # The branch the action should deploy to.
+          FOLDER: docs # The folder the action should deploy.

.gitignore

@@ -74,3 +74,4 @@ reports
 
 temp
 docs
+keys

package.json

@@ -1,68 +1,69 @@
 {
-  "name": "purser",
-  "private": true,
-  "version": "3.0.0",
-  "description": "Interact with Ethereum wallets easily",
-  "scripts": {
-    "bootstrap": "lerna bootstrap",
-    "build": "lerna run build",
-    "test": "npm run lint && npm run typecheck && jest",
-    "lint": "lerna run lint",
-    "lint:fix": "lerna run lint -- -- --fix",
-    "publish": "lerna publish",
-    "typecheck": "tsc --noEmit",
-    "prepublishOnly": "npm test && npm run build"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/JoinColony/purser.git"
-  },
-  "author": "Raul Glogovetan <[email protected]>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/JoinColony/purser/issues"
-  },
-  "homepage": "https://github.com/JoinColony/purser",
-  "keywords": [
-    "ethereum",
-    "javascript",
-    "wallet",
-    "colony",
-    "software-wallet",
-    "monorepo",
-    "purser"
-  ],
-  "devDependencies": {
-    "@colony/eslint-config-colony": "8.0.1",
-    "@strictsoftware/typedoc-plugin-monorepo": "^0.3.1",
-    "@types/bn.js": "^4.11.6",
-    "@types/jest": "^25.2.1",
-    "@typescript-eslint/eslint-plugin": "^2.29.0",
-    "@typescript-eslint/parser": "^2.29.0",
-    "camelcase": "5.3.1",
-    "chalk": "3.0.0",
-    "chokidar": "3.3.1",
-    "cross-env": "^6.0.3",
-    "denodeify": "1.2.1",
-    "eslint": "6.8.0",
-    "eslint-config-airbnb-base": "14.1.0",
-    "eslint-config-prettier": "6.11.0",
-    "eslint-plugin-eslint-comments": "3.1.2",
-    "eslint-plugin-import": "2.20.2",
-    "eslint-plugin-jest": "^23.9.0",
-    "eslint-plugin-prettier": "3.1.3",
-    "find-imports": "1.1.0",
-    "fs-extra": "8.1.0",
-    "husky": "4.2.3",
-    "jest": "25.1.0",
-    "jest-sandbox": "1.1.2",
-    "lerna": "^3.20.2",
-    "lint-staged": "10.0.8",
-    "prettier": "2.0.5",
-    "rimraf": "^3.0.2",
-    "ts-jest": "^25.3.1",
-    "typedoc": "^0.17.0-3",
-    "typescript": "^3.8.3"
-  },
-  "dependencies": {}
+    "name": "purser",
+    "private": true,
+    "version": "3.0.0",
+    "description": "Interact with Ethereum wallets easily",
+    "scripts": {
+        "bootstrap": "lerna bootstrap",
+        "build": "lerna run build",
+        "build-docs": "typedoc packages/@purser/core/src/index.ts packages/@purser/metamask/src/index.ts packages/@purser/software/src/index.ts packages/@purser/signer-ethers/src/index.ts",
+        "test": "npm run lint && npm run typecheck && jest",
+        "lint": "lerna run lint",
+        "lint:fix": "lerna run lint -- -- --fix",
+        "publish": "lerna publish",
+        "typecheck": "tsc --noEmit",
+        "prepublishOnly": "npm test && npm run build"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/JoinColony/purser.git"
+    },
+    "author": "Raul Glogovetan <[email protected]>",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/JoinColony/purser/issues"
+    },
+    "homepage": "https://github.com/JoinColony/purser",
+    "keywords": [
+        "ethereum",
+        "javascript",
+        "wallet",
+        "colony",
+        "software-wallet",
+        "monorepo",
+        "purser"
+    ],
+    "devDependencies": {
+        "@colony/eslint-config-colony": "8.0.1",
+        "@strictsoftware/typedoc-plugin-monorepo": "^0.3.1",
+        "@types/bn.js": "^4.11.6",
+        "@types/jest": "^25.2.1",
+        "@typescript-eslint/eslint-plugin": "^2.29.0",
+        "@typescript-eslint/parser": "^2.29.0",
+        "camelcase": "5.3.1",
+        "chalk": "3.0.0",
+        "chokidar": "3.3.1",
+        "cross-env": "^6.0.3",
+        "denodeify": "1.2.1",
+        "eslint": "6.8.0",
+        "eslint-config-airbnb-base": "14.1.0",
+        "eslint-config-prettier": "6.11.0",
+        "eslint-plugin-eslint-comments": "3.1.2",
+        "eslint-plugin-import": "2.20.2",
+        "eslint-plugin-jest": "^23.9.0",
+        "eslint-plugin-prettier": "3.1.3",
+        "find-imports": "1.1.0",
+        "fs-extra": "8.1.0",
+        "husky": "4.2.3",
+        "jest": "25.1.0",
+        "jest-sandbox": "1.1.2",
+        "lerna": "^3.20.2",
+        "lint-staged": "10.0.8",
+        "prettier": "2.0.5",
+        "rimraf": "^3.0.2",
+        "ts-jest": "^25.3.1",
+        "typedoc": "^0.17.0-3",
+        "typescript": "^3.8.3"
+    },
+    "dependencies": {}
 }