From 0f220a8c2a61a78dd24392ff893342f5df90bd3b Mon Sep 17 00:00:00 2001
From: Lexus Drumgold <unicornware@flexdevelopment.llc>
Date: Mon, 10 Apr 2023 03:47:27 -0400
Subject: [PATCH] ci(workflows): add `typescript-canary`

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>
---
 .github/workflows/typescript-canary.yml | 83 +++++++++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 .github/workflows/typescript-canary.yml

diff --git a/.github/workflows/typescript-canary.yml b/.github/workflows/typescript-canary.yml
new file mode 100644
index 00000000..1930f638
--- /dev/null
+++ b/.github/workflows/typescript-canary.yml
@@ -0,0 +1,83 @@
+# TypeScript Canary Check
+#
+# Run type tests against the latest and next versions of TypeScript.
+#
+# References:
+#
+# - https://docs.github.com/actions/learn-github-actions/contexts
+# - https://docs.github.com/actions/using-jobs/using-a-matrix-for-your-jobs
+# - https://docs.github.com/actions/using-workflows/events-that-trigger-workflows#schedule
+# - https://docs.github.com/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch
+# - https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions
+# - https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow_dispatch
+# - https://github.com/actions/checkout
+# - https://github.com/actions/setup-node
+# - https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md#yarn2-configuration
+# - https://github.com/hmarr/debug-action
+# - https://vitest.dev/guide/testing-types.html#run-typechecking
+
+---
+name: typescript-canary
+on:
+  schedule:
+    # every day, 3 hours after typescript@next release
+    # https://github.com/microsoft/TypeScript/blob/v4.9.5/.github/workflows/nightly.yaml
+    - cron: 0 10 * * *
+  workflow_dispatch:
+permissions:
+  contents: read
+  packages: read
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  HUSKY: 0
+concurrency:
+  cancel-in-progress: true
+  group: ${{ github.workflow }}-${{ github.ref }}
+jobs:
+  typescript-canary:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        typescript-version:
+          - next
+          - latest
+    steps:
+      - id: debug
+        name: Print environment variables and event payload
+        uses: hmarr/debug-action@v2.1.0
+      - id: checkout
+        name: Checkout ${{ github.ref_name }}
+        uses: actions/checkout@v3.5.0
+        with:
+          persist-credentials: false
+          ref: ${{ github.ref }}
+      - id: node
+        name: Setup Node.js
+        uses: actions/setup-node@v3.6.0
+        with:
+          cache: yarn
+          cache-dependency-path: yarn.lock
+          node-version-file: .nvmrc
+      - id: yarn
+        name: Install dependencies
+        run: yarn ${{ github.actor == 'dependabot[bot]' && '--no-immutable' || '--immutable' }}
+      - id: typescript
+        name: Install typescript@${{ matrix.typescript-version }}
+        run: yarn add -D typescript@${{ matrix.typescript-version }}
+      - id: set-typescript-version
+        name: Set env.TYPESCRIPT_VERSION
+        run: |
+          echo "TYPESCRIPT_VERSION=$(jq .devDependencies.typescript package.json -r)" >>$GITHUB_ENV
+      - id: print-typescript-version
+        name: Print TypeScript version
+        run: echo $TYPESCRIPT_VERSION
+      - id: build
+        name: Build project
+        run: yarn build
+      - id: typecheck
+        name: Run typecheck
+        run: yarn typecheck
+      - id: typecheck-build
+        name: Run typecheck-build
+        run: yarn check:types:build