Merge pull request #60 from ubilabs/chore/workflows

Chore/workflows

Author: plumdumpling

.github/workflows/publish.yml

@@ -1,15 +1,16 @@
 name: Publish package
+
 on:
   push:
     tags:
       - "v*" # Push events to matching v*, i.e. v1.0, v20.15.10
+
 jobs:
   create-release:
     name: Create Release
     runs-on: ubuntu-latest
     outputs:
       upload_url: ${{ steps.create_release.outputs.upload_url }}
-
     steps:
       - name: Create Release
         id: create_release
@@ -26,12 +27,27 @@ jobs:
     name: Publish to NPM
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - name: Checkout repository from GitHub
+        uses: actions/checkout@v2.3.1
+      - name: Setup npm
+        uses: actions/setup-node@v2
         with:
-          node-version: "12.x"
+          node-version: "16"
           registry-url: "https://registry.npmjs.org"
-      - run: npm install
-      - run: npm publish --access public
+      # npm cache folder is in ~/, not within the working directory
+      - name: Cache npm directory
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      # Node auth token is needed for private GitHub registry
+      - name: Install dependencies
+        run: npm install
+      - name: Run tests
+        run: npm run test
+      - name: Publish
+        run: npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_BOT_ACCESS_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Run Tests
+
+on: push
+
+jobs:
+  create-release:
+    name: Test
+    runs-on: ubuntu-latest
+    timeout-minutes: 8
+    steps:
+      - name: Checkout repository from GitHub
+        uses: actions/checkout@v2.3.1
+      - name: Setup npm
+        uses: actions/setup-node@v2
+        with:
+          node-version: "16"
+      # npm cache folder is in ~/, not within the working directory
+      - name: Cache npm directory
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      # Node auth token is needed for private GitHub registry
+      - name: Install dependencies
+        run: npm install
+      - name: Run tests
+        run: npm run test

examples/basic-google-map/README.md

@@ -6,7 +6,15 @@ This is an example setup to show a **basic Google Map** with the Google Maps Rea
 
 To run this project, clone the Google Maps React Hooks repository locally.
 
-At the root of the repository, run:
+First go to the root of the repository and run
+
+```shell
+npm install
+```
+
+once to install all dependencies.
+
+Then start this example locally with
 
 ```shell
 npm run start:sample-map

examples/geocoding/README.md

@@ -6,7 +6,15 @@ This is an example setup to show the usage of the **useGeocoder hook** with the
 
 To run this project, clone the Google Maps React Hooks repository locally.
 
-At the root of the repository, run:
+First go to the root of the repository and run
+
+```shell
+npm install
+```
+
+once to install all dependencies.
+
+Then start this example locally with
 
 ```shell
 npm run start:geocoding-example

examples/google-map-with-markers/README.md

@@ -6,7 +6,15 @@ This is an example setup to show a **Google Map with markers** with the Google M
 
 To run this project, clone the Google Maps React Hooks repository locally.
 
-At the root of the repository, run:
+First go to the root of the repository and run
+
+```shell
+npm install
+```
+
+once to install all dependencies.
+
+Then start this example locally with
 
 ```shell
 npm run start:map-with-markers

package.json

@@ -14,17 +14,18 @@
   "scripts": {
     "build": "rm -rf dist/* && microbundle -o dist/index.js -f modern,umd --external react=React --sourcemap false --jsx React.createElement --no-compress --tsconfig ./tsconfig.json",
     "dev": "rm -rf dist/* && microbundle watch -o dist/index.js -f modern,umd --external react=React --sourcemap false --jsx React.createElement --no-compress --tsconfig ./tsconfig.json",
-    "lint": "eslint './src/**/*.{ts,tsx}'",
+    "lint": "eslint './{src,examples}/**/*.{ts,tsx}'",
     "types": "tsc --project tsconfig.json --noEmit",
     "test": "npm run lint && npm run types",
     "prepublishOnly": "npm run test && npm run build",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
     "preversion": "npm run test",
     "version": "npm run changelog && git checkout -b chore/release-${npm_package_version} && git add .",
     "postversion": "git push -u origin chore/release-${npm_package_version} && git push --tags --no-verify",
-    "start:sample-map": "cd examples && npm run clean-examples && npm i && npm run start:map",
-    "start:map-with-markers": "cd examples && npm run clean-examples && npm i && npm run start:map-markers",
-    "start:geocoding-example": "cd examples && npm run clean-examples && npm i && npm run start:geocoding",
+    "postinstall": "npm install --prefix examples",
+    "start:sample-map": "cd examples && npm run clean-examples && npm run start:map",
+    "start:map-with-markers": "cd examples && npm run clean-examples && npm run start:map-markers",
+    "start:geocoding-example": "cd examples && npm run clean-examples && npm run start:geocoding",
     "start:places-example": "cd examples && npm run clean-examples && npm run start:places",
     "start:autocomplete-example": "cd examples && npm run clean-examples && npm run start:autocomplete",
     "start:directions-example": "cd examples && npm run clean-examples && npm run start:directions"