Installer polish: Windows MSI options (shortcuts, finish page, PATH option, branding) + macOS DMG branding parity
Maintainer thường phản hồi trong vòng 1 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 25/100
Hướng nghiên cứu
Start with pyproject.toml, the installation guides, and the linked design spec at docs/superpowers/specs/2026-11-17-windows-installer-polish-design.md; check Briefcase 0.4.7's installer options and packaging workflow. The work spans MSI scripts and branding, macOS DMG assets, and English and French documentation. Done means implementing the listed installer options and branding, updating the docs and changelog, and preserving the stated silent install and uninstall behavior.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Problem statement
The Windows MSI (ProFiles-<version>.msi) is built with Briefcase defaults. Consequences today:
- No desktop shortcut: the installation guide promises "a Start Menu entry and desktop shortcut are created" (
docs/installation-guide.en.md:26), but with the current config Briefcase creates no desktop shortcut — the docs are ahead of reality. - Bare finish page: no "Launch ProFiles" convenience, no links to docs/what's new after install.
- No install-time conveniences:
profiles --headlessautomation is a documented usage mode, but the packaged app is not on PATH, so terminal use requires typing the full install path. - Stock installer branding (plain WiX look), and the macOS DMG ships a plain backdrop while the project has brand assets.
All of Briefcase 0.4.7's platform installer options (verified against the v0.4.7 docs and source) are currently unused — there is no [tool.briefcase.app.profiles.windows] section in pyproject.toml.
Use cases / evidence
- Installing on shared production test machines (per-machine scope, admin) vs personal PCs (per-user, no admin): the MSI can offer the choice at install time — it is just not surfaced/documented today.
- An operator finishes the install; the natural next step is to open ProFiles immediately — the MSI can offer a checked "Launch ProFiles" box on the finish page.
- Field engineers run
profiles --headlessfrom scripts (documented in the installation guide); with the install dir on PATH this works from any terminal, out of the box. - New-machine setup: branded installer + shortcut make the first-run experience match the product.
Proposed solution
Full design spec: docs/superpowers/specs/2026-11-17-windows-installer-polish-design.md (committed with the implementation PR). Summary:
Windows MSI ([tool.briefcase.app.profiles.windows]):
- Install scope choice (per-user / per-machine) kept as the wizard dialog (Briefcase default —
system_installerunset), made explicit with a pyproject comment. create_desktop_shortcut = true— desktop shortcut checkbox, checked by default.- English finish page: "Launch ProFiles" checkbox, custom completion text, links to Documentation and What's new (CHANGELOG); custom uninstaller completion text.
- Install option
add_to_path(checked by default, both scopes): post-install.batadds the install dir to PATH (HKCU per-user / HKLM per-machine viaALLUSERS), using PowerShell from the.bat(avoidssetx's 1024-char truncation; handlesREG_EXPAND_SZ+WM_SETTINGCHANGE). - Pre-uninstall
.batremoves exactly that PATH entry — never touches.profilesconfigs or logs. - Installer branding:
installer_background(493×312 BMP) +installer_banner(493×58 BMP), derived from existingimg/assets and committed.
macOS DMG branding parity ([tool.briefcase.app.profiles.macOS]):
installer_background— PNG backdrop for the DMG window.installer_icon— DMG volume icon reusingimg/profiles.icns.
Docs: installation guide (en/fr) updated — the shortcut claim becomes true; scope choice and PATH option documented; CHANGELOG entry under [Unreleased].
Interactive installer features (scope dialog, finish page, checkboxes, uninstall script) are MSI-only by the nature of each platform's install model — see the parity table in the spec. The DMG branding items are the only portable piece; Linux deb has no installer UI (menu entry is already automatic via FreeDesktop registration).
Anti-goals: no user-data deletion on uninstall; msiexec /qn silent installs keep working; no non-English installer surface (English-first app).
Alternatives considered
- Declarative-only (pyproject switches, no scripts): simplest, but no PATH convenience.
- + aggressive uninstall cleanup (checkbox to delete config/logs): rejected — uninstall options don't display in the standard Add/Remove Programs flow (upstream quirk), and user-data deletion is risky.
starter_configinstall option (generate a first.profiles): dropped — an installer cannot know where the test-programs tree lives;ProFiles.exe --initstays available manually.- macOS PKG instead of DMG: would add
post_install_scriptparity but loses the drag-to-Applications UX the guide documents, and changesrelease.yml.
Scope
- Packaging / CI
- Documentation
Pre-submission checklist
- I searched existing issues (open and closed) for this feature
- This does not conflict with an open PR implementing the same thing
- Ngôn ngữ chính
- Python
- Star
- 1
- Fork
- 1
- Merge trung bình
- 4 giờ 46 phút
- Pull request đã merge (30 ngày)
- 55
Chuẩn bị môi trường
Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của falbany/ProFiles
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
falbany/ProFiles#187 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Web UI: config handoff from a second launch leaves the open YAML editor showing stale contentĐang mởbug frontend
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Maintainer thường phản hồi trong vòng 1 ngày
-
bug frontend
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
Maintainer thường phản hồi trong vòng 1 ngày
-
bug frontend
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của falbany/ProFiles
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
ip-tools/patzilla#219 · 2 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
EPSSClient commits to its SQLite cache once per score: a 100-CVE bulk fetch makes 101 disk flushesĐang mởpriority:p3 technical-debt
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
jimmy058910/jmo-security-repo#1673 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
enhancement ready
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 86/100
-
integration: frontier_silicon
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
home-assistant/core#193176 · 2 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
task create and task update take --body-file and --stdinCó thể đã có người làm @JuanBarriosS đã nhận hôm nay. Đang mởcli enhancement good first issue help wanted
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 92/100
pyrite-wiki/pyrite#1687 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày