Document and finalize release binary flow

Author: henryoman

README.md

@@ -174,3 +174,18 @@ simulateTransaction({ instructions, payer, rpc, options? })
 ## License
 
 MIT
+
+## Release Flow
+
+1. Configure repo secret `NPM_TOKEN` in GitHub Actions (use an npm automation token).
+2. Cut a release from local once your branch is ready:
+   - `bun run release:cut patch`
+   - or `bun run release:cut minor`
+   - or `bun run release:cut major`
+   - or explicit: `bun run release:cut 0.2.1`
+3. The script runs `bun run ci`, bumps `package.json`, commits, tags, and pushes.
+4. Tag push (`vX.Y.Z`) triggers `.github/workflows/release.yml`:
+   - runs CI
+   - builds a Bun Linux binary (`dist/bin/pump-kit`)
+   - uploads release assets (`pump-kit-linux-x64`, `.sha256`, `.tar.gz`)
+   - publishes npm package.

package.json

@@ -27,7 +27,7 @@
     "lint": "oxlint --deny-warnings src tests scripts examples",
     "lint:fix": "oxlint --fix --deny-warnings src tests scripts examples",
     "build:js": "bun build ./src/index.ts --outdir dist --format esm --minify",
-    "build:binary": "mkdir -p dist/bin && bun build --compile --outfile dist/bin/pump-kit ./src/bin/pump-kit.ts",
+    "build:binary": "mkdir -p dist/bin && PUMP_KIT_VERSION=$(node -p \"require('./package.json').version\") bun build --compile --env='PUMP_KIT_*' --outfile dist/bin/pump-kit ./src/bin/pump-kit.ts",
     "build:types": "tsc -p tsconfig.build.json",
     "build": "rm -rf dist && bun run build:js && bun run build:types",
     "ci": "bun run dev:typecheck && bun run lint && bun run test:unit && bun run test:integration && bun run build",

src/bin/pump-kit.ts

@@ -3,6 +3,11 @@
 import { readFileSync } from "node:fs";
 
 function readVersion(): string {
+  const fromEnv = process.env.PUMP_KIT_VERSION;
+  if (fromEnv && fromEnv.length > 0) {
+    return fromEnv;
+  }
+
   try {
     const pkgUrl = new URL("../../package.json", import.meta.url);
     const pkg = JSON.parse(readFileSync(pkgUrl, "utf8")) as { version?: string };