Introduce upgrades to CI/CD (#18)

* Introduce typechecking scripts * Introduce coverage testing * Introduce upgraded CI/CD * Apply suggestions from code review Co-authored-by: Luc <[email protected]> --------- Co-authored-by: Luc <[email protected]>
v3xlabs · Sep 26, 2023 · d1bc3ca · d1bc3ca
1 parent 9b9546d
commit d1bc3ca
Show file tree

Hide file tree

Showing 13 changed files with 273 additions and 27 deletions.
diff --git a/.github/actions/setup/action.yaml b/.github/actions/setup/action.yaml
@@ -0,0 +1,20 @@
+name: "Setup dependencies"
+description: "Prepare repository and all dependencies"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Set up pnpm
+      uses: pnpm/action-setup@v2
+      with:
+          version: 8
+
+    - name: Setup Node.js 18.x
+      uses: actions/setup-node@v3
+      with:
+          node-version: 18.x
+          cache: 'pnpm'
+
+    - name: Install dependencies
+      shell: bash
+      run: pnpm install
diff --git a/.github/workflows/on-pull-request.yaml b/.github/workflows/on-pull-request.yaml
@@ -0,0 +1,14 @@
+name: Pull request
+on:
+    pull_request:
+        types: [opened, reopened, synchronize, ready_for_review]
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+    cancel-in-progress: true
+
+jobs:
+    verify:
+        name: Verify
+        uses: ./.github/workflows/verify.yml
+        secrets: inherit
diff --git a/.github/workflows/changesets.yaml → .github/workflows/on-push-master.yaml b/.github/workflows/changesets.yaml → .github/workflows/on-push-master.yaml
@@ -8,24 +8,19 @@ on:
 concurrency: ${{ github.workflow }}-${{ github.ref }}
 
 jobs:
-    release:
-        name: Release
+    verify:
+        name: Verify
+        uses: ./.github/workflows/verify.yml
+        secrets: inherit
+    changesets:
+        name: Changesets
         runs-on: ubuntu-latest
         steps:
             - name: Checkout Repo
               uses: actions/checkout@v3
-            - uses: pnpm/action-setup@v2
-              with:
-                  version: 8
-
-            - name: Setup Node.js 18.x
-              uses: actions/setup-node@v3
-              with:
-                  node-version: 18.x
-                  cache: 'pnpm'
 
             - name: Install Dependencies
-              run: pnpm install
+              uses: ./.github/actions/setup
 
             - name: Create Release Pull Request or Publish to npm
               id: changesets

diff --git a/.github/workflows/verify.yaml b/.github/workflows/verify.yaml
@@ -0,0 +1,66 @@
+name: Verify
+on:
+    workflow_call:
+    workflow_dispatch:
+
+jobs:
+    lint:
+        name: Lint
+        runs-on: ubuntu-latest
+        timeout-minutes: 5
+
+        steps:
+            - uses: actions/checkout@v3
+
+            - name: Install dependencies
+              uses: ./.github/actions/setup
+
+            - name: Lint code
+              run: pnpm lint
+
+    build:
+        name: Build
+        needs: lint
+        runs-on: ubuntu-latest
+        timeout-minutes: 5
+
+        steps:
+            - uses: actions/checkout@v3
+
+            - name: Install dependencies
+              uses: ./.github/actions/setup
+
+            - name: Build
+              run: pnpm build
+
+    types:
+        name: Types
+        needs: lint
+        runs-on: ubuntu-latest
+        timeout-minutes: 5
+
+        steps:
+            - uses: actions/checkout@v3
+
+            - name: Install dependencies
+              uses: ./.github/actions/setup
+
+            - name: Check types
+              run: pnpm typecheck
+
+    test:
+        name: Test
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v3
+
+            - name: Install dependencies
+              uses: ./.github/actions/install-dependencies
+
+            - name: Run tests
+              uses: nick-fields/retry@v2
+              with:
+                  timeout_minutes: 20
+                  max_attempts: 3
+                  command: pnpm test:coverage
diff --git a/package.json b/package.json
@@ -6,7 +6,12 @@
   "main": "index.js",
   "scripts": {
     "sync:deps": "syncpack",
-    "release": "pnpm -r build && changeset publish"
+    "release": "pnpm -r build && changeset publish",
+    "build": "pnpm -r build",
+    "lint": "pnpm -r lint",
+    "test": "pnpm -r test",
+    "test:coverage": "pnpm -r test -- --coverage",
+    "typecheck": "pnpm -r typecheck"
   },
   "keywords": [],
   "author": "",

diff --git a/packages/base/tsconfig.base.json b/packages/base/tsconfig.base.json
@@ -3,7 +3,7 @@
         "moduleResolution": "node",
         "target": "es2022",
         "module": "es2022",
-        "lib": ["es2015", "es2016", "es2017", "es2020"],
+        "lib": ["es2015", "es2016", "es2017", "es2020", "DOM"],
         "strict": true,
         "declaration": true,
         "allowSyntheticDefaultImports": true,

diff --git a/packages/chains/package.json b/packages/chains/package.json
@@ -8,7 +8,8 @@
     "lint": "eslint --ext .ts,.tsx src",
     "pub": "pnpm publish --no-git-checks",
     "build": "tsup",
-    "test": "vitest run"
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
   },
   "exports": {
     ".": {
@@ -22,6 +23,7 @@
   "license": "lgpl-3.0",
   "devDependencies": {
     "@ens-tools/base": "workspace:*",
+    "@vitest/coverage-v8": "^0.34.5",
     "tsup": "^7.2.0",
     "typescript": "^5.2.2",
     "vitest": "^0.34.5"

diff --git a/packages/chains/tsconfig.json b/packages/chains/tsconfig.json
@@ -1,3 +1,5 @@
 {
-    "extends": ["@ens-tools/base/tsconfig.base.json"],
+    "extends": [
+        "@ens-tools/base/tsconfig.base.json"
+    ],
 }
diff --git a/packages/format/package.json b/packages/format/package.json
@@ -8,7 +8,8 @@
     "test": "vitest run",
     "lint": "eslint --ext .ts,.tsx src",
     "pub": "pnpm publish --no-git-checks",
-    "build": "tsup"
+    "build": "tsup",
+    "typecheck": "tsc --noEmit"
   },
   "exports": {
     ".": {
@@ -48,6 +49,8 @@
   "license": "lgpl-3.0",
   "devDependencies": {
     "@ens-tools/base": "workspace:*",
+    "@types/node": "^20.7.0",
+    "@vitest/coverage-v8": "^0.34.5",
     "tsup": "^7.2.0",
     "typescript": "^5.2.2",
     "vitest": "^0.34.5"

diff --git a/packages/format/tsconfig.json b/packages/format/tsconfig.json
@@ -1,3 +1,5 @@
 {
-    "extends": ["@ens-tools/base/tsconfig.base.json"],
+    "extends": [
+        "@ens-tools/base/tsconfig.base.json"
+    ],
 }
diff --git a/packages/react/package.json b/packages/react/package.json
@@ -8,7 +8,8 @@
     "lint": "eslint --ext .ts,.tsx src",
     "pub": "pnpm publish --no-git-checks",
     "build": "tsup",
-    "test": "vitest run"
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
   },
   "exports": {
     ".": {
@@ -23,7 +24,9 @@
   "devDependencies": {
     "@ens-tools/base": "workspace:*",
     "@testing-library/react": "^14.0.0",
+    "@types/node": "^20.7.0",
     "@types/react": "^18.2.21",
+    "@vitest/coverage-v8": "^0.34.5",
     "eslint": "^8.49.0",
     "happy-dom": "^12.1.6",
     "react-dom": "^18.2.0",

diff --git a/packages/react/tsconfig.json b/packages/react/tsconfig.json
@@ -1,3 +1,5 @@
 {
-    "extends": ["@ens-tools/base/tsconfig.base.json"],
+    "extends": [
+        "@ens-tools/base/tsconfig.base.json"
+    ],
 }