Installer polish: Windows MSI options (shortcuts, finish page, PATH option, branding) + macOS DMG branding parity

未关闭
#183 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
macos, python
领域
devops, release

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

enhancement

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 --headless automation 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 --headless from 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]):

  1. Install scope choice (per-user / per-machine) kept as the wizard dialog (Briefcase default — system_installer unset), made explicit with a pyproject comment.
  2. create_desktop_shortcut = true — desktop shortcut checkbox, checked by default.
  3. English finish page: "Launch ProFiles" checkbox, custom completion text, links to Documentation and What's new (CHANGELOG); custom uninstaller completion text.
  4. Install option add_to_path (checked by default, both scopes): post-install .bat adds the install dir to PATH (HKCU per-user / HKLM per-machine via ALLUSERS), using PowerShell from the .bat (avoids setx's 1024-char truncation; handles REG_EXPAND_SZ + WM_SETTINGCHANGE).
  5. Pre-uninstall .bat removes exactly that PATH entry — never touches .profiles configs or logs.
  6. Installer branding: installer_background (493×312 BMP) + installer_banner (493×58 BMP), derived from existing img/ assets and committed.

macOS DMG branding parity ([tool.briefcase.app.profiles.macOS]):

  1. installer_background — PNG backdrop for the DMG window.
  2. installer_icon — DMG volume icon reusing img/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_config install option (generate a first .profiles): dropped — an installer cannot know where the test-programs tree lives; ProFiles.exe --init stays available manually.
  • macOS PKG instead of DMG: would add post_install_script parity but loses the drag-to-Applications UX the guide documents, and changes release.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
主要语言
Python
星标
1
派生
1
平均合并
4 小时 46 分钟
30 天内合并 PR
55

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

falbany/ProFiles 的其他 Issue

查看 falbany/ProFiles 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。