Skip to content

chore: fix-local-release #538

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryanbas21 merged 1 commit into from
Feb 25, 2026
Merged

chore: fix-local-release #538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
264 changes: 199 additions & 65 deletions tools/release/commands/commands.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,67 +1,201 @@
import { Effect, Stream, Console } from 'effect';
import { Effect } from 'effect';
import { Command } from '@effect/platform';
import { FileSystem, Path } from '@effect/platform';
import {
CommandExitError,
GitStatusError,
ChangesetError,
ChangesetConfigError,
GitRestoreError,
} from '../errors';
Comment on lines +1 to +10
Copy link

@coderabbitai coderabbitai bot Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Find eslint config files
fd -a -E node_modules -E dist -E build -E .git -E .turbo -E .nx -E .cache -E .changeset 'eslint\.config\..*|\.eslintrc\..*|\.eslintrc$' | head -20

Repository: ForgeRock/ping-javascript-sdk

Length of output: 1227

🏁 Script executed:

#!/bin/bash
# Confirm the exact offending import
rg -n "from '\.\./errors'" tools/release/commands/commands.ts -A 5 -B 5

Repository: ForgeRock/ping-javascript-sdk

Length of output: 306

🏁 Script executed:

#!/bin/bash
# Check what the ../errors path actually is
fd -path "*release/errors*" --type f | head -20

Repository: ForgeRock/ping-javascript-sdk

Length of output: 241

🏁 Script executed:

#!/bin/bash
# Inspect the eslint config content if found
find . -maxdepth 3 -name "eslint.config.*" -o -name ".eslintrc*" 2>/dev/null | grep -v node_modules | head -5 | xargs -I {} sh -c 'echo "=== {} ===" && head -100 {}'

Repository: ForgeRock/ping-javascript-sdk

Length of output: 2689

🏁 Script executed:

#!/bin/bash
# Check root eslint config for import/extensions rule
head -200 ./eslint.config.mjs

Repository: ForgeRock/ping-javascript-sdk

Length of output: 4572

🏁 Script executed:

#!/bin/bash
# Find the errors module in tools/release
find tools/release -name "errors*" | head -20

Repository: ForgeRock/ping-javascript-sdk

Length of output: 96

🏁 Script executed:

#!/bin/bash
# Check if tools/release has its own eslint config
ls -la tools/release/ | grep eslint

Repository: ForgeRock/ping-javascript-sdk

Length of output: 55

Add explicit .js extension to relative import.
The ESLint rule import/extensions: [2, 'ignorePackages'] requires file extensions for relative imports. Change ../errors to ../errors.js to resolve this linting error.

Suggested fix 
 import {
   CommandExitError,
   GitStatusError,
   ChangesetError,
   ChangesetConfigError,
   GitRestoreError,
-} from '../errors';
+} from '../errors.js';
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
import { Effect } from 'effect';
import { Command } from '@effect/platform';
import { FileSystem, Path } from '@effect/platform';
import {
CommandExitError,
GitStatusError,
ChangesetError,
ChangesetConfigError,
GitRestoreError,
} from '../errors';
import { Effect } from 'effect';
import { Command } from '@effect/platform';
import { FileSystem, Path } from '@effect/platform';
import {
CommandExitError,
GitStatusError,
ChangesetError,
ChangesetConfigError,
GitRestoreError,
} from '../errors.js';
🧰 Tools
🪛 ESLint

[error] 10-10: Missing file extension for "../errors"

(import/extensions)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@tools/release/commands/commands.ts` around lines 1 - 10, Update the relative
import to include the .js extension: change the import source string used to
pull in the exported error types (the import line that lists CommandExitError,
GitStatusError, ChangesetError, ChangesetConfigError, GitRestoreError) from
'../errors' to '../errors.js' so it satisfies the import/extensions ESLint rule
while keeping the named imports unchanged.


export const buildPackages = Command.make('pnpm', 'build').pipe(
Command.string,
Stream.tap((line) => Console.log(`Build: ${line}`)),
Stream.runDrain,
);

// Effect to check git status for staged files
export 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
export const runChangesetsSnapshot = Command.make(
'pnpm',
'changeset',
'version',
'--snapshot',
'beta',
).pipe(Command.exitCode);

// Effect to start local registry (run in background)
export 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
);

export const restoreGitFiles = Command.make('git', 'restore', '.').pipe(Command.start);

export const publishPackages = Command.make(
'pnpm',
'publish',
'-r',
'--tag',
'beta',
'--registry=http://localhost:4873',
'--no-git-checks',
).pipe(
Command.string,
Stream.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,
);
const SNAPSHOT_TAG = 'beta';
const LOCAL_REGISTRY_URL = 'http://localhost:4873';

/**
* Runs a command with fully inherited stdio and `CI=true` so that tools
* like Nx use non-interactive output. Fails with `CommandExitError` if
* the exit code is non-zero.
*
* @param description - Human-readable label for the command (e.g. "pnpm build")
* @param cmd - The Effect Command to execute
*/
const runInherited = (description: string, cmd: Command.Command) =>
cmd.pipe(
Command.env({ CI: 'true' }),
Command.stdin('inherit'),
Command.stdout('inherit'),
Command.stderr('inherit'),
Command.exitCode,
Effect.flatMap((code) =>
code === 0
? Effect.void
: Effect.fail(
new CommandExitError({
message: `${description} exited with code ${code}`,
cause: `Non-zero exit code: ${code}`,
command: description,
exitCode: code,
}),
),
),
);

/** Fails with `GitStatusError` if the git working tree has staged changes. */
export const assertCleanGitStatus = Effect.gen(function* () {
const output = yield* Command.make('git', 'status', '--porcelain').pipe(Command.string);

const hasStagedChanges = output.split('\n').some((line) => /^[MADRCU] /.test(line));

if (hasStagedChanges) {
yield* Effect.fail(
new GitStatusError({
message: 'Git has staged changes. Commit or stash them before releasing.',
cause: 'Staged changes detected in git working tree',
}),
);
}

yield* Effect.log('Git status clean — no staged changes.');
});

/** Fails with `ChangesetError` if the `.changeset/` directory contains no changeset markdown files. */
export const assertChangesetsExist = Effect.gen(function* () {
const fs = yield* FileSystem.FileSystem;
const path = yield* Path.Path;

const changesetDir = path.join(process.cwd(), '.changeset');

const files = yield* fs.readDirectory(changesetDir).pipe(
Effect.catchTag('SystemError', (e) =>
Effect.fail(
new ChangesetError({
message:
e.reason === 'NotFound'
? 'No .changeset directory found.'
: `Failed to read .changeset directory: ${e.message}`,
cause: e.reason,
}),
),
),
);

const hasChangesets = files
.filter((f) => f !== 'README.md' && f !== 'config.json')
.some((f) => f.endsWith('.md'));

if (!hasChangesets) {
yield* Effect.fail(
new ChangesetError({
message: 'No changeset files found. Add a changeset before releasing.',
cause: 'No markdown files in .changeset directory',
}),
);
}

yield* Effect.log('Changeset files found.');
});

/**
* Versions all packages as snapshot releases via `changeset version --snapshot`.
* Temporarily disables the GitHub changelog in `.changeset/config.json` to avoid
* requiring a GITHUB_TOKEN for local releases. The modified config is reverted
* by `restoreGitFiles`.
*/
export const versionSnapshotPackages = Effect.gen(function* () {
const fs = yield* FileSystem.FileSystem;
const path = yield* Path.Path;

const configPath = path.join(process.cwd(), '.changeset', 'config.json');

const raw = yield* fs.readFileString(configPath).pipe(
Effect.catchTag('SystemError', (e) =>
Effect.fail(
new ChangesetConfigError({
message: `Failed to read .changeset/config.json: ${e.message}`,
cause: e.reason,
}),
),
),
);

const config: Record<string, unknown> = yield* Effect.try({
try: () => JSON.parse(raw) as Record<string, unknown>,
catch: (e) =>
new ChangesetConfigError({
message: 'Invalid JSON in .changeset/config.json',
cause: String(e),
}),
});

if (typeof config !== 'object' || config === null || Array.isArray(config)) {
yield* Effect.fail(
new ChangesetConfigError({
message: '.changeset/config.json must be a JSON object',
cause: `Unexpected shape: ${typeof config}`,
}),
);
}

config.changelog = false;
yield* fs.writeFileString(configPath, JSON.stringify(config, null, 2) + '\n').pipe(
Effect.catchTag('SystemError', (e) =>
Effect.fail(
new ChangesetConfigError({
message: `Failed to write .changeset/config.json: ${e.message}`,
cause: e.reason,
}),
),
),
);

yield* Effect.log('Running changeset version --snapshot...');
yield* runInherited(
'changeset version --snapshot',
Command.make('pnpm', 'changeset', 'version', '--snapshot', SNAPSHOT_TAG),
);
yield* Effect.log('Snapshot versioning complete.');
});

/** Runs `pnpm build` with output visible in the terminal. */
export const buildPackages = Effect.gen(function* () {
yield* runInherited('pnpm build', Command.make('pnpm', 'build'));
yield* Effect.log('Build complete.');
});

/** Starts the Verdaccio local registry as a background process. */
export const startLocalRegistry = Effect.gen(function* () {
yield* Command.make('pnpm', 'nx', 'local-registry').pipe(Command.start, Effect.asVoid);
yield* Effect.log('Verdaccio local registry starting...');
});

/** Publishes all packages to the local Verdaccio registry. */
export const publishToLocalRegistry = Effect.gen(function* () {
yield* runInherited(
'pnpm publish',
Command.make(
'pnpm',
'publish',
'-r',
'--tag',
SNAPSHOT_TAG,
`--registry=${LOCAL_REGISTRY_URL}`,
'--no-git-checks',
),
);
yield* Effect.log('Packages published to local registry.');
});

/** Restores all modified files in the working tree via `git restore .`. */
export const restoreGitFiles = Effect.gen(function* () {
const code = yield* Command.make('git', 'restore', '.').pipe(Command.exitCode);

if (code !== 0) {
yield* Effect.fail(
new GitRestoreError({
message: `git restore exited with code ${code}`,
cause: `Non-zero exit code: ${code}`,
}),
);
}
});
48 changes: 48 additions & 0 deletions tools/release/errors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import { Data } from 'effect';

/** Staged changes detected in git working tree. */
export class GitStatusError extends Data.TaggedError('GitStatusError')<{
message: string;
cause: string;
}> {}

/** Missing `.changeset/` directory or no changeset markdown files found. */
export class ChangesetError extends Data.TaggedError('ChangesetError')<{
message: string;
cause: string;
}> {}

/** A shell command exited with a non-zero exit code. */
export class CommandExitError extends Data.TaggedError('CommandExitError')<{
message: string;
cause: string;
command: string;
exitCode: number;
}> {}

/** `.changeset/config.json` is unreadable, contains invalid JSON, or has an unexpected shape. */
export class ChangesetConfigError extends Data.TaggedError('ChangesetConfigError')<{
message: string;
cause: string;
}> {}

/** Verdaccio registry did not respond within the retry timeout. */
export class RegistryNotReadyError extends Data.TaggedError('RegistryNotReadyError')<{
message: string;
cause: string;
}> {}

/** `git restore .` failed during cleanup. */
export class GitRestoreError extends Data.TaggedError('GitRestoreError')<{
message: string;
cause: string;
}> {}

/** Union of all typed errors the release pipeline can produce. */
export type ReleaseError =
| GitStatusError
| ChangesetError
| CommandExitError
| ChangesetConfigError
| RegistryNotReadyError
| GitRestoreError;
Loading
Loading