fix: add Windows desktop shortcut installer option#503
Conversation
|
ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (4)
🚧 Files skipped from review as they are similar to previous changes (3)
📝 WalkthroughWalkthroughAdds a Windows installer desktop-shortcut opt-in flow in NSIS (custom page, macros, install/uninstall handlers), updates Electron Builder NSIS options to disable default desktop shortcut and include the NSIS script with en_US/zh_CN, and adds tests plus release-checklist verification for the new behavior. ChangesWindows Desktop Shortcut Installer Control
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related issues
Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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 |
There was a problem hiding this comment.
Code Review
This pull request implements custom Windows installer shortcut logic for the PawWork application, including language-aware shortcut names and a custom installer page for desktop shortcut selection. The changes involve updates to the NSIS configuration, a new NSH script, and comprehensive tests for installer logic and release documentation. Feedback identifies opportunities to improve the installer UI by using a descriptive page caption and to simplify the NSH script by removing redundant macro calls and manual file deletions.
There was a problem hiding this comment.
Code Review
This pull request implements custom Windows installer shortcut logic using NSIS scripts to support localized shortcut names in English and Chinese. The changes include updates to the release checklist, configuration adjustments in electron-builder.config.ts, and new tests to verify shortcut behavior during installation and updates. Review feedback highlights opportunities to extend localization and cleanup logic to include Beta and Dev channels, and identifies redundant macro calls and manual file deletions in the installer.nsh script.
|
P1 update-path concern rejected after checking the concrete electron-builder/electron-updater code in this repo version. Evidence:
So the premise that update execution lacks |
|
Accepted the scope-switch P1 and fixed it in 6342435. What changed:
Verification:
|
|
Accepted the new scope/permission P1 and fixed it in 5d08f68. What changed:
Verification:
Still needs real Windows verification before closing #500, especially All users -> Just me with the UAC prompt accepted. |
Summary
Adds a Windows NSIS installer checkbox for creating a desktop shortcut, with English and Chinese labels.
Keeps Start Menu shortcut creation enabled, disables electron-builder's automatic desktop shortcut, and moves desktop shortcut ownership into the installer script so auto-updates do not mutate it.
Updates the release checklist to require Windows desktop and Start Menu shortcut evidence.
Why
Windows installers were not creating a desktop shortcut. Users also need an explicit installer choice so reinstalling can intentionally create or skip the desktop shortcut without auto-update changing their desktop.
Related Issue
Addresses #500
Human Review Status
Pending. A human should make the final merge decision after reviewing the final diff and verification evidence.
Review Focus
Windows NSIS installer behavior:
Risk Notes
Windows installer behavior changed. I verified NSIS compilation on macOS by building the Windows installer, but a real Windows machine still needs to install the generated
.exeand verify actual desktop and Start Menu behavior before closing #500.How To Verify
Screenshots or Recordings
Not captured locally. This is a Windows installer dialog change; real Windows installer verification is called out in the release checklist.
Checklist
dev, and my PR title and commit messages use Conventional Commits in EnglishSummary by CodeRabbit
New Features
Documentation
Tests