fix(desktop): set linux.executableName for AppImage build - #298
Conversation
electron-builder's Linux AppImage builder rejects names with characters
outside [letters digits hyphens underscores dots spaces]. By default
it derives the executable name from package.json's `name` field —
`@readied/desktop` strips to `@readieddesktop`, still leading with `@`,
still invalid.
Explicit override: `linux.executableName: "readied"`. mac and win don't
hit this because they use productName ("Readied") or the appId
(app.readied.desktop) instead. Linux is the strict one.
Root cause behind the v0.15.1 release shipping with no binaries — the
linux job failed at AppImage build, the publish job (needs build) was
skipped, no electron-updater feed was produced.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Review limit reached
More reviews will be available in 18 minutes and 24 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
Bot
added
dependencies
## Why v0.15.1 Build (run 27212685957) failed on linux because electron-builder rejected the AppImage build: \`executableName contains invalid chars: @readieddesktop\`. publish job (\`needs: build\`) was skipped, no binaries reached the GitHub Release, v0.15.1 has been marked draft. This brings the linux fix from #298 (already on develop) into main as a cherry-pick so semantic-release can cut v0.15.2. ## Why not the original develop → main PR (#299) I created a sync PR (#300) earlier to bring main's release-cycle commits (CHANGELOG + version bump) back to develop. Squash-merging that sync PR collapsed the merge ancestry — develop has main's content but not main's commit history, so #299 stayed permanently BEHIND. Cherry-picking the linux fix straight to main sidesteps that. After this lands and Release cuts v0.15.2, the auto sync-develop job in build.yml will bring the v0.15.2 release commits back to develop with proper ancestry. ## Diff \`apps/desktop/package.json\`: \`"executableName": "readied"\` added to \`build.linux\`. Single line. mac+win already build cleanly because they use \`productName\` ("Readied") and \`appId\` (\`app.readied.desktop\`) respectively. ## Expected Build flow semantic-release reads main's commit log since v0.15.1: - \`fix(desktop): set linux.executableName for AppImage build (#298)\` → patch bump → v0.15.2 cut as draft → Build runs on mac/win/linux → all 3 publish to draft → \`publish\` job undrafts → \`sync-develop\` PRs main → develop.
1 participant
Why
v0.15.1 Build run (27212685957) failed on linux:
```
⨯ failed to build AppImage error=executableName contains characters that
cannot be safely used in file paths: @readieddesktop. Please use only
letters, digits, hyphens, underscores, dots, and spaces.
```
electron-builder defaults Linux's `executableName` to the package.json `name` field, stripped of unsafe chars. `@readied/desktop` → `@readieddesktop`, still leading with `@`, still invalid.
mac and win didn't fail because they use `productName` ("Readied") and the `appId` (`app.readied.desktop`) respectively — Linux is the strict one for the on-disk binary name.
Fix
Add `linux.executableName: "readied"` to apps/desktop/package.json's `build` config.
Knock-on
v0.15.1 Build flow was:
After this lands, the next Release will produce binaries for all 3 platforms.
v0.15.1 cleanup
The published v0.15.1 GitHub Release will be marked as draft via gh api so it doesn't surface to users with electron-updater. v0.15.2 will be cut after this PR merges.