Uh oh!
There was an error while loading. Please reload this page.
feat(dry-run): Add worktree-based dry-run mode with real diff output - #692
Merged
Conversation
Implement an enhanced dry-run mode that creates a temporary git worktree, allowing local operations to execute in isolation while showing a real diff of what would change. Key changes: - Create temporary worktree for dry-run operations - Allow pre-release commands and file writes in worktree mode - Show formatted git diff at the end of dry-run - Block only remote operations (push, GitHub API mutations) - Add signal handlers for cleanup on Ctrl+C - Add comprehensive unit and e2e tests with snapshot testing
Contributor
Semver Impact of This PR🟡 Minor (new features) 📋 Changelog PreviewThis is how your changes will appear in the changelog. New Features ✨
Bug Fixes 🐛
Build / dependencies / internal 🔧
🤖 This preview updates automatically when you update the PR. |
Contributor
|
…ation API - Move all worktree logic from worktree.ts into dryRun.ts - Create unified createDryRunIsolation() function that: - Returns null if not in dry-run mode (no isDryRun() check needed) - Handles worktree creation, mode enabling, and cleanup internally - Provides git client, showDiff(), and cleanup() methods - Update prepare.ts to use the new API, removing explicit isDryRun() checks - Delete worktree.ts and worktree.test.ts (merged into dryRun.ts) This simplifies the API surface: consumers just call createDryRunIsolation() and use the returned object, rather than stitching together multiple functions from different modules.
Instead of returning null in non-dry-run mode, return a passthrough object with no-op methods. This eliminates conditional checks around isolation usage - just call the methods unconditionally.
Instead of hiding success messages in dry-run mode, show them to give users a complete picture of what the output would look like. Added isIsolated property to DryRunIsolation to allow checking if we're in an isolated worktree (needed to skip switchToDefaultBranch which would fail since main is already checked out in the original repo).
execPublish was being called while worktree mode was still active, which would allow safeExec() calls to actually run (npm publish, etc.). Now we skip execPublish entirely in isolated mode and show a message indicating what would have run.
BYK
marked this pull request as ready for review
January 7, 2026 21:58
Lms24
approved these changes
Jan 9, 2026
Uh oh!
There was an error while loading. Please reload this page.
- Replace npx ts-node with locally installed tsx for e2e tests - Add tsx as devDependency - Rename vitest.config.ts to vitest.config.mts for ESM compatibility - Fix signal handler race condition: don't call process.exit() immediately after cleanup to give Sentry time to flush telemetry - Fix removeAllListeners bug: only remove our handlers, not Sentry's
Comment on lines
133
to
-140
| return function (...args: unknown[]) { | ||
| if (isDryRun()) { | ||
| const argsStr = args | ||
| .map(a => (typeof a === 'string' ? a : JSON.stringify(a))) | ||
| .join(' '); | ||
| logDryRun(`git.${prop}(${argsStr})`); | ||
| // Return a mock result if the method's return value is accessed, | ||
| // otherwise return the proxy directly for chaining compatibility. |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
E2E tests should test the actual built artifact, not transpiled source. This is faster and more realistic. - Remove tsx dependency - Update tests to use dist/craft binary - Add beforeAll hook to build if binary doesn't exist
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implements an enhanced
--dry-runmode that creates a temporary git worktree, allowing local operations to execute in isolation while showing a real diff of what would change.Changes
New Worktree-Based Dry-Run Flow
/tmp/craft-dry-run-*git diffat the end showing exactly what would changeKey Features
node_modules,vendor, etc. are symlinked for pre-release scriptsExample Output
Testing