Uh oh!
There was an error while loading. Please reload this page.
fix(release): install.sh --install-dir and release docs - #202
Conversation
🦋 Changeset detectedLatest commit: 784e05e The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Stack: wyattjoh/release-clerk-1-0-0 Part of a stacked PR chain. Do not merge manually. |
When install.sh is invoked with --install-dir pointing at a directory that does not yet exist, the final `mv` failed because mkdir only ran inside the ~/.local/bin fallback branch. Run mkdir -p unconditionally just before the move so explicit custom paths match the fallback behavior.
The releaser moved from scripts/releaser/ to scripts/releaser.ts, and target definitions from scripts/releaser/targets.ts to scripts/lib/targets.ts, but docs/releasing.md still pointed at the old paths. The documented dry-run command therefore failed with "Module not found", and nothing explained that the releaser reads from a CI-style $ARTIFACTS_DIR/clerk-<target>/ layout rather than the dist/artifacts/<target>/ layout produced by scripts/build.ts. Replace the five stale paths, rewrite the dry-run section with a working single-target rehearsal recipe that stages binaries under the expected CI layout, and add a note about the Bun 1.3.11 CI pin so local darwin-arm64 rehearsal matches what CI builds.
6e04847 to
784e05eCompare📝 WalkthroughWalkthroughThis pull request updates the release and installation infrastructure across three files. It adds a changeset entry documenting a patch-level fix, updates documentation references for build artifacts and release process paths (from Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@install.sh`:
- Around line 269-270: Add an automated test that verifies installer creates a
non-existent custom --install-dir and moves the binary (exercise INSTALL_DIR,
TMPDIR, BINARY_NAME, EXT logic in install.sh): write a test that creates a
unique temp path that does not exist, invokes the installer with --install-dir
pointing at that path, then assert the directory was created and the binary
"${BINARY_NAME}${EXT}" was moved from TMPDIR to
"${INSTALL_DIR}/${BINARY_NAME}${EXT}" (and optionally check executable
permissions and exit code), and clean up after the run; place the test alongside
existing installer integration tests so future changes to mkdir -p or mv
behavior are covered.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: ae0a5359-78a3-487a-8b7a-4265694f1ac8
📒 Files selected for processing (3)
.changeset/install-sh-create-install-dir.mddocs/releasing.mdinstall.sh
Uh oh!
There was an error while loading. Please reload this page.
Summary
install.shnow creates the--install-dirtarget when it does not already exist, so./install.sh --install-dir /new/pathsucceeds on a fresh directory. Previouslymkdir -ponly ran inside the~/.local/binfallback branch, and the finalmvfailed on any user-supplied path that did not exist.docs/releasing.mdstops pointing at the removedscripts/releaser/directory (moved toscripts/releaser.tsandscripts/lib/targets.ts), documents that the releaser expects the CI-style$ARTIFACTS_DIR/clerk-<target>/layout (distinct from thedist/artifacts/<target>/layout written byscripts/build.ts), and notes the Bun 1.3.11 pin used by CI so local darwin-arm64 rehearsal matches production.Context
Follow-up to #199. Covers the remaining release-readiness gaps surfaced during review of the 1.0.0 prep branch. Stacked on top of #199 so review stays scoped. Changelog entry added for the
install.shfix; docs change is non-user-facing and needs no changeset.Test plan
install.sh --install-dir /tmp/new-pathfailure, confirmed the fix resolves it.docs/releasing.mdagainst a stagedclerk-darwin-arm64/artifact.bun run format:check,lint,typecheck,testall pass locally.