chore: introduce release-please and update dependencies (#572)

* chore: update dependencies
* chore: update build-script for bundlewatch
* chore: add release-please, update all other workflows

.github/workflows/bundlewatch.yml

@@ -27,9 +27,21 @@ jobs:
     env:
       CI_BRANCH_BASE: main
     steps:
-      - uses: actions/checkout@v2
-      - uses: jackyef/bundlewatch-gh-action@b9753bc9b3ea458ff21069eaf6206e01e046f0b5
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Bundlewatch
+        uses: jackyef/bundlewatch-gh-action@b9753bc9b3ea458ff21069eaf6206e01e046f0b5
         with:
-          build-script: npm i
+          build-script: npm run prepack
           bundlewatch-github-token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
           bundlewatch-config: .github/bundlewatch.config.json

.github/workflows/codeql.yml

@@ -53,7 +53,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL

.github/workflows/docs.yml

@@ -15,20 +15,26 @@
 name: Docs
 on: [push, pull_request]
 jobs:
-  test:
+  docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v2
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
         with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-      - run: |
-          npm i
-          npm run docs
-      - uses: peaceiris/actions-gh-pages@v3
+          node-version: 20
+          cache: npm
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Build Documentation
+        run: npm run docs
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
         if: github.ref == 'refs/heads/main'
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/e2e.yml

@@ -28,9 +28,20 @@ jobs:
         ports:
           - 4444:4444
     steps:
-      - uses: actions/checkout@v2
-      - run: npm i
-      - run: npm run test:e2e
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: End to End Tests
+        run: npm run test:e2e
         env:
           GOOGLE_MAPS_API_KEY: ${{ secrets.SYNCED_GOOGLE_MAPS_API_KEY_WEB }}
   firefox:
@@ -43,9 +54,20 @@ jobs:
         ports:
           - 4444:4444
     steps:
-      - uses: actions/checkout@v2
-      - run: npm i
-      - run: npm run test:e2e
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: End to End Tests
+        run: npm run test:e2e
         env:
           GOOGLE_MAPS_API_KEY: ${{ secrets.SYNCED_GOOGLE_MAPS_API_KEY_WEB }}
           BROWSER: firefox

.github/workflows/release-please.yml

@@ -0,0 +1,75 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+## Runs the release-please action for all new pushes to the main branch.
+##   This will create new release-PRs, create GitHub releases and update
+##   the CHANGELOG.md.
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+name: Release Please
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - id: release
+        name: Release Please
+        uses: google-github-actions/release-please-action@v3
+
+        with:
+          release-type: node
+          token: ${{ secrets.SYNCED_GITHUB_TOKEN_REPO }}
+          package-name: "@googlemaps/typescript-guards"
+          bump-minor-pre-major: true
+
+      # Everything below is for NPM publishing when a release is cut.
+      # Note the "if" statement on all commands to make sure that publishing
+      # only happens when a release is cut.
+
+      - if: ${{ steps.release.outputs.release_created }}
+        name: Checkout
+        uses: actions/checkout@v3
+
+      - if: ${{ steps.release.outputs.release_created }}
+        name: Setup Node for Dependency Installation
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: npm
+
+      - if: ${{ steps.release.outputs.release_created }}
+        name: Install Dependencies
+        run: npm ci
+
+      # Now configure node with the registry used for publishing
+      - if: ${{ steps.release.outputs.release_created }}
+        name: Setup Node for Publishing
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          registry-url: "https://wombat-dressing-room.appspot.com/"
+
+      - if: ${{ steps.release.outputs.release_created }}
+        name: Publish
+        # npm publish will trigger the build via the prepack hook
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_WOMBAT_TOKEN }}

.github/workflows/test.yml

@@ -17,15 +17,24 @@ on: [push, pull_request]
 jobs:
   test:
     runs-on: ubuntu-latest
-    steps:      
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v2
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
         with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-      - run: npm i
-      - run: npm run lint
-      - run: npm test
-      - uses: codecov/codecov-action@v1
+          node-version: 20
+          cache: npm
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Run eslint
+        run: npm run lint
+
+      - name: Run Tests
+        run: npm test
+
+      - name: Collect Coverage Data
+        uses: codecov/codecov-action@v1

jest.config.mjs

@@ -15,9 +15,8 @@
  */
 
 export default {
-  transform: {
-    "^.+\\.tsx?$": "ts-jest",
-  },
+  preset: "ts-jest/presets/js-with-ts",
+  testEnvironment: "jsdom",
   collectCoverage: true,
   coverageThreshold: {
     global: {