chore: create-local-release-script

created a local release script for releasing repo packages to verdaccio

Author: ryanbas21

.github/workflows/publish.yml

@@ -83,7 +83,7 @@ jobs:
           payload-delimiter: '_'
           webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
           webhook-type: webhook-trigger
-          payload: steps.changesets.outputs.publishedPackages
+          payload: ${{ steps.changesets.outputs.publishedPackages }}
 
       - uses: codecov/codecov-action@v5
         with:

package.json

@@ -85,6 +85,7 @@
     "conventional-changelog-conventionalcommits": "^8.0.0",
     "cz-conventional-changelog": "^3.3.0",
     "cz-git": "^1.6.1",
+    "effect": "^3.12.7",
     "eslint": "^9.8.0",
     "eslint-config-prettier": "10.1.2",
     "eslint-plugin-import": "2.31.0",
@@ -126,5 +127,8 @@
   },
   "nx": {
     "includedScripts": []
+  },
+  "dependencies": {
+    "@effect/cli": "0.59.9"
   }
 }

pnpm-lock.yaml

@@ -0,0 +1,146 @@
+import { Effect, Console, Stream } from 'effect';
+import { Command } from '@effect/platform';
+import { NodeContext, NodeRuntime } from '@effect/platform-node';
+import { FileSystem, Path } from '@effect/platform';
+
+// Effect to check git status for staged files
+const checkGitStatus = Command.make('git', 'status', '--porcelain').pipe(
+  Command.string,
+  Effect.flatMap((output) => {
+    // Check if the output contains lines indicating staged changes (e.g., starting with M, A, D, R, C, U followed by a space)
+    const stagedChanges = output.split('\n').some((line) => /^[MADRCU] /.test(line.trim()));
+    if (stagedChanges) {
+      return Effect.fail(
+        'Git repository has staged changes. Please commit or stash them before releasing.',
+      );
+    }
+    return Effect.void; // No staged changes
+  }),
+  // If the command fails (e.g., not a git repo), treat it as an error too.
+  Effect.catchAll((error) => Effect.fail(`Git status check command failed: ${error}`)),
+  Effect.tapError((error) => Console.error(error)), // Log the specific error message
+  Effect.asVoid, // Don't need the output on success
+);
+
+// Effect to run changesets snapshot
+const runChangesetsSnapshot = Command.make(
+  'pnpm',
+  'changesets',
+  'version',
+  '--snapshot',
+  'beta',
+).pipe(
+  Command.lines, // Get output line by line
+  Effect.tap((line) => Console.log(`Changesets: ${line}`)), // Log output
+  Stream.runDrain, // Consume the stream and wait for completion
+  Effect.tapBoth({
+    onFailure: (error) => Console.error(`Changesets snapshot command failed: ${error}`),
+    onSuccess: () => Console.log('Changesets snapshot completed successfully.'),
+  }),
+  Effect.asVoid, // Don't need the final result
+);
+
+// Effect to start local registry (run in background)
+const startLocalRegistry = Command.make('pnpm', 'nx', 'local-registry').pipe(
+  Command.start, // Starts the process and returns immediately
+  Effect.tap(() =>
+    Console.log('Attempting to start local registry (Verdaccio) in the background...'),
+  ),
+  Effect.tapError((error) => Console.error(`Failed to start local registry: ${error}`)),
+  Effect.asVoid, // We don't need the Process handle for this script's logic
+);
+
+const restoreGitFiles = Command.make('git', 'restore', '.').pipe(Command.start);
+const publishPackages = Command.make(
+  'pnpm',
+  'publish',
+  '-r',
+  '--tag',
+  'beta',
+  '--registry=http://localhost:4873',
+).pipe(
+  Command.lines, // Stream output line by line
+  Effect.tap((line) => Console.log(`Publish: ${line}`)),
+  Stream.runDrain,
+  Effect.tapBoth({
+    onFailure: (error) => Effect.fail(() => Console.error(`Publishing failed: ${error}`)),
+    onSuccess: () => Console.log('Packages were published successfully to the local registry.'),
+  }),
+  Effect.asVoid,
+);
+
+// Effect to check for the presence of changeset files
+const checkForChangesets = Effect.gen(function* () {
+  yield* Console.log('Checking for changeset files...');
+
+  const fs = yield* FileSystem.FileSystem;
+  const path = yield* Path.Path;
+
+  const changesetDir = path.join(process.cwd(), '.changesets');
+
+  // 3. Read the directory and check for *.md files (excluding README.md)
+  const files = yield* fs.readDirectory(changesetDir).pipe(
+    Effect.catchTag('SystemError', (e) => {
+      // If the directory doesn't exist, treat it as "no changesets found"
+      if (e.reason === 'NotFound') {
+        return Effect.fail('No changesets found. Please add a changeset before releasing.');
+      }
+      // Otherwise, propagate the error
+      return Effect.fail(`An unexpected error occured ${e}`);
+    }),
+  );
+
+  const hasChangesetFiles = files.every((file) => file.endsWith('.md') && file !== 'README.md');
+
+  if (!hasChangesetFiles) {
+    yield* Effect.fail('No changesets found. Please add a changeset before releasing.');
+  }
+
+  yield* Console.log('Changeset files found.');
+}).pipe(
+  Effect.tapError((error) => Console.error(`Changeset check failed: ${error}`)), // Log specific failure reason
+);
+
+// Main program flow using Effect.gen
+const program = Effect.gen(function* () {
+  yield* Console.log('Starting release script...');
+
+  yield* Console.log('Checking Git status for staged files...');
+  yield* checkGitStatus; // This will fail the Effect if staged changes exist
+  yield* Console.log('Git status OK (no staged files found).');
+
+  // Check for changesets *before* running snapshot
+  yield* checkForChangesets;
+
+  yield* Console.log('Running Changesets snapshot version...');
+  yield* runChangesetsSnapshot;
+
+  yield* startLocalRegistry;
+  // Add delay to give Verdaccio time to start up. Adjust duration if needed.
+  yield* Console.log('Waiting for local registry to initialize... (5 seconds)');
+  yield* Effect.sleep('5 seconds');
+
+  yield* Console.log('Publishing packages to local registry...');
+  yield* publishPackages;
+
+  yield* Console.log(
+    'Release script finished. Local registry should still be running in the background.',
+  );
+
+  yield* restoreGitFiles;
+
+  yield* Effect.never; // Keep script running if needed, e.g., for background process
+}).pipe(
+  // Fallback for any other Failures (like strings from Effect.fail)
+  Effect.catchAll((error) => {
+    if (typeof error === 'string') {
+      return Console.error(`Error: ${error}`);
+    }
+    // Handle unexpected error types if necessary
+    return Console.error(`An unexpected error occurred: ${JSON.stringify(error)}`);
+  }),
+  Effect.provide(NodeContext.layer), // Provide necessary Node services (includes FileSystem, Path, CommandExecutor)
+);
+
+// Execute the program using the Node runtime
+NodeRuntime.runMain(Effect.scoped(program));

tools/release/release.ts

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "files": [],
+  "include": ["./release.ts"],
+  "compilerOptions": {
+    "moduleResolution": "NodeNext",
+    "module": "NodeNext",
+    "target": "ES2024",
+    "strict": true
+  },
+  "nx": {
+    "addTypecheckTarget": false
+  }
+}