setup build and release packages (#262)

Co-authored-by: Tomek Kopacki <[email protected]>

.changeset/config.json

@@ -10,7 +10,6 @@
   "ignore": [
     "ensnode",
     "@ensnode/ensrainbow",
-    "@ensnode/utils",
     "@docs/ensnode",
     "@docs/ensrainbow"
   ]

.changeset/hot-terms-approve.md

@@ -0,0 +1,11 @@
+---
+"@ensnode/ponder-subgraph": minor
+"@ensnode/ens-deployments": minor
+"@ensnode/ensrainbow-sdk": minor
+"@ensnode/shared-configs": minor
+"@ensnode/utils": minor
+"@ensnode/ponder-schema": minor
+"ensadmin": minor
+---
+
+Initial Release

.github/workflows/ci.yml

@@ -9,6 +9,20 @@ on:
       - main
 
 jobs:
+  changed-packages:
+    runs-on: ubuntu-latest
+    outputs:
+      packages: ${{ steps.changes.outputs.packages }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check for package changes
+        id: changes
+        uses: dorny/paths-filter@v2
+        with:
+          filters: |
+            packages:
+              - 'packages/**'
+
   static-analysis:
     runs-on: ubuntu-latest
 
@@ -36,6 +50,10 @@ jobs:
       - name: Run TypeScript type checks
         run: pnpm -r typecheck
 
+      - name: Build packages
+        if: needs.changed-packages.outputs.packages == 'true'
+        run: pnpm packages:prepublish
+
       # This will run the dev command in background, wait for
       # RUNTIME_CHECK_TIMEOUT_SECONDS seconds, and then kill the process if it
       # is still running. If the command does not throw an error within that
@@ -84,4 +102,3 @@ jobs:
 
       - name: Run unit tests
         run: pnpm -r test
-

.github/workflows/release.yml

@@ -0,0 +1,48 @@
+name: Release Packages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "packages/**"
+      - ".changeset/**"
+  workflow_dispatch:
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+
+jobs:
+  release:
+    name: Release Packages
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Create Release PR or Publish to NPM
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          commit: "chore(release): version packages"
+          title: "chore(release): version packages"
+          publish: pnpm release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

apps/ensadmin/eslint.config.js

@@ -1,9 +1,9 @@
 import js from "@eslint/js";
+import importPlugin from "eslint-plugin-import";
 import reactHooks from "eslint-plugin-react-hooks";
 import reactRefresh from "eslint-plugin-react-refresh";
 import globals from "globals";
 import tseslint from "typescript-eslint";
-import importPlugin from "eslint-plugin-import";
 
 export default tseslint.config(
   {
@@ -27,10 +27,7 @@ export default tseslint.config(
     },
     rules: {
       ...reactHooks.configs.recommended.rules,
-      "react-refresh/only-export-components": [
-        "warn",
-        { allowConstantExport: true },
-      ],
+      "react-refresh/only-export-components": ["warn", { allowConstantExport: true }],
       // Match Biome's formatting rules
       quotes: ["error", "double"],
       indent: ["error", 2, { SwitchCase: 1 }],
@@ -49,14 +46,7 @@ export default tseslint.config(
       "import/order": [
         "error",
         {
-          groups: [
-            "builtin",
-            "external",
-            "internal",
-            "parent",
-            "sibling",
-            "index",
-          ],
+          groups: ["builtin", "external", "internal", "parent", "sibling", "index"],
           "newlines-between": "always",
           alphabetize: {
             order: "asc",
@@ -65,5 +55,5 @@ export default tseslint.config(
         },
       ],
     },
-  }
+  },
 );

apps/ensrainbow/src/lib/server.ts

@@ -2,11 +2,7 @@ import { type EnsRainbow, ErrorCode, StatusCode, labelHashToBytes } from "@ensno
 import { ByteArray } from "viem";
 import { logger } from "../utils/logger";
 import { parseNonNegativeInteger } from "../utils/number-utils";
-import {
-  LABELHASH_COUNT_KEY,
-  ensureIngestionNotIncomplete,
-  isIngestionInProgress,
-} from "./database";
+import { LABELHASH_COUNT_KEY, ensureIngestionNotIncomplete } from "./database";
 import { ENSRainbowDB, safeGet } from "./database";
 
 export class ENSRainbowServer {

package.json

@@ -6,11 +6,14 @@
   "scripts": {
     "lint": "pnpm -r lint",
     "lint:ci": "pnpm -r lint:ci",
-    "changeset": "changeset"
+    "changeset": "changeset",
+    "release": "changeset publish",
+    "packages:prepublish": "pnpm -r --filter='@ensnode/*' prepublish"
   },
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
     "@changesets/cli": "^2.27.12",
+    "tsup": "catalog:",
     "typescript": "catalog:"
   },
   "engines": {
@@ -20,6 +23,7 @@
     "overrides": {
       "ponder>vite": "5.4.14",
       "astro>esbuild": "0.25.0",
+      "tsup>esbuild": "0.25.0",
       "tsx>esbuild": "0.25.0",
       "vite>esbuild": "0.25.0"
     }

packages/ens-deployments/package.json

@@ -12,23 +12,32 @@
   "homepage": "https://github.com/namehash/ensnode/tree/main/packages/ens-deployments",
   "keywords": ["ENS", "ENSNode"],
   "exports": "./src/index.ts",
+  "files": ["dist"],
+  "publishConfig": {
+    "access": "public",
+    "exports": {
+      "default": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "main": "./dist/index.js",
+    "module": "./dist/index.mjs",
+    "types": "./dist/index.d.ts"
+  },
   "scripts": {
+    "prepublish": "tsup",
     "lint:ci": "biome ci"
   },
   "peerDependencies": {
     "viem": "^catalog:"
   },
   "devDependencies": {
-    "@ensnode/shared-configs": "workspace:",
     "@biomejs/biome": "catalog:",
     "@ensnode/shared-configs": "workspace:",
+    "tsup": "catalog:",
     "typescript": "catalog:",
     "viem": "catalog:"
   },
   "dependencies": {
     "@ponder/utils": "^0.2.3"
-  },
-  "publishConfig": {
-    "access": "public"
   }
 }

packages/ens-deployments/tsup.config.ts

@@ -0,0 +1,18 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: ["src/index.ts"],
+  platform: "browser",
+  format: ["esm"],
+  target: "es2022",
+  bundle: true,
+  splitting: false,
+  sourcemap: true,
+  dts: true,
+  clean: true,
+  external: ["viem", "@ponder/utils"],
+  outDir: "./dist",
+  esbuildOptions(options) {
+    options.mainFields = ["browser", "module", "main"];
+  },
+});

packages/ensnode-utils/package.json

@@ -1,6 +1,5 @@
 {
   "name": "@ensnode/utils",
-  "private": true,
   "version": "0.0.1",
   "type": "module",
   "description": "A utility library for interacting with ENS data",
@@ -16,7 +15,26 @@
     "./subname-helpers": "./src/subname-helpers.ts",
     "./types": "./src/types.ts"
   },
+  "files": ["dist"],
+  "publishConfig": {
+    "access": "public",
+    "exports": {
+      "./cache": {
+        "types": "./dist/cache.d.ts",
+        "default": "./dist/cache.js"
+      },
+      "./subname-helpers": {
+        "types": "./dist/subname-helpers.d.ts",
+        "default": "./dist/subname-helpers.js"
+      },
+      "./types": {
+        "types": "./dist/types.d.ts",
+        "default": "./dist/types.js"
+      }
+    }
+  },
   "scripts": {
+    "prepublish": "tsup",
     "lint": "biome check --write .",
     "lint:ci": "biome ci",
     "test": "vitest",
@@ -26,9 +44,10 @@
     "viem": "^catalog:"
   },
   "devDependencies": {
-    "@ensnode/shared-configs": "workspace:",
     "@biomejs/biome": "catalog:",
+    "@ensnode/shared-configs": "workspace:",
     "@types/node": "catalog:",
+    "tsup": "^8.3.6",
     "typescript": "catalog:",
     "viem": "catalog:",
     "vitest": "catalog:"

packages/ensnode-utils/tsup.config.ts

@@ -0,0 +1,21 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: {
+    "subname-helpers": "src/subname-helpers.ts",
+    types: "src/types.ts",
+  },
+  platform: "browser",
+  format: ["esm"],
+  target: "es2022",
+  bundle: true,
+  splitting: false,
+  sourcemap: true,
+  dts: true,
+  clean: true,
+  external: ["viem"],
+  outDir: "./dist",
+  esbuildOptions(options) {
+    options.mainFields = ["browser", "module", "main"];
+  },
+});

packages/ensrainbow-sdk/package.json

@@ -17,7 +17,33 @@
     "./consts": "./src/consts.ts",
     "./label-utils": "./src/label-utils.ts"
   },
+  "files": ["dist"],
+  "publishConfig": {
+    "access": "public",
+    "exports": {
+      ".": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "./client": {
+        "types": "./dist/client.d.ts",
+        "default": "./dist/client.js"
+      },
+      "./consts": {
+        "types": "./dist/consts.d.ts",
+        "default": "./dist/consts.js"
+      },
+      "./label-utils": {
+        "types": "./dist/label-utils.d.ts",
+        "default": "./dist/label-utils.js"
+      }
+    },
+    "main": "./dist/index.js",
+    "module": "./dist/index.mjs",
+    "types": "./dist/index.d.ts"
+  },
   "scripts": {
+    "prepublish": "tsup",
     "test": "vitest",
     "typecheck": "tsc --noEmit",
     "lint": "biome check --write",
@@ -27,13 +53,11 @@
     "viem": "catalog:"
   },
   "devDependencies": {
-    "@ensnode/shared-configs": "workspace:",
     "@biomejs/biome": "catalog:",
+    "@ensnode/shared-configs": "workspace:",
     "@ensnode/utils": "workspace:",
+    "tsup": "catalog:",
     "typescript": "catalog:",
     "vitest": "catalog:"
-  },
-  "publishConfig": {
-    "access": "public"
   }
 }

packages/ensrainbow-sdk/tsup.config.ts

@@ -0,0 +1,24 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: {
+    client: "src/client.ts",
+    consts: "src/consts.ts",
+    index: "src/index.ts",
+    labelUtils: "src/label-utils.ts",
+    "label-utils": "src/label-utils.ts",
+  },
+  platform: "browser",
+  format: ["esm"],
+  target: "es2022",
+  bundle: true,
+  splitting: false,
+  sourcemap: true,
+  dts: true,
+  clean: true,
+  external: ["viem", "@ensnode/utils"],
+  outDir: "./dist",
+  esbuildOptions(options) {
+    options.mainFields = ["browser", "module", "main"];
+  },
+});