Skip to content

MSI: Update documentation#1248

Merged
lrandersson merged 4 commits into
conda:briefcase-integrationfrom
lrandersson:dev-ra-873
Jun 1, 2026
Merged

MSI: Update documentation#1248
lrandersson merged 4 commits into
conda:briefcase-integrationfrom
lrandersson:dev-ra-873

Conversation

@lrandersson
Copy link
Copy Markdown
Contributor

Description

Checklist - did you ...

  • Add a file to the news directory (using the template) for the next release's release notes?
  • Add / update necessary tests?
  • Add / update outdated documentation?

@github-project-automation github-project-automation Bot moved this to 🆕 New in 🔎 Review May 27, 2026
@conda-bot conda-bot added the cla-signed [bot] added once the contributor has signed the CLA label May 27, 2026
@lrandersson lrandersson marked this pull request as ready for review May 28, 2026 13:59
@lrandersson lrandersson requested a review from a team as a code owner May 28, 2026 13:59
@lrandersson lrandersson self-assigned this May 28, 2026
Comment thread docs/source/cli-options.md Outdated
| Property | Description | Default |
|----------|-------------|---------|
| `ALLUSERS` | `1` for all users, `0` (or empty) for current user | Per-user |
| `TARGETDIR` | Installation directory | `%LOCALAPPDATA%\<name>` or `%PROGRAMFILES%\<name>` |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should mention that the former is for current user and the latter for all users.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed 13a5933

Comment thread docs/source/cli-options.md Outdated
MSI installers can be uninstalled via:

1. **Add/Remove Programs**: Right-click and select "Uninstall"
2. **Double-clicking the MSI file**: Shows a dialog with "Repair" and "Remove" options. **This is the only way to access uninstall options** like removing caches or config files.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume that limitation is due to the MSI format, not briefcase? Is there a way we could manipulate the registry entry somehow to make it work with Option 1?

It's also not quite true that this is the only way since 3. provides those options, too.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, I fixed it here 13a5933.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To answer the question about the registry manipulation: Yes it's possible, this is actually configured via the WiX template (right now hardcoded and not possible to configure from the installer builder POV).

I think the current setting is standard behavior and changing this could in theory break automated scripts and/or deployment tools that just expect it to work (to uninstall silently), but I would need to read up more on this in order to make an accurate statement.

Comment thread docs/source/howto.md Outdated
Comment on lines +270 to +272
[Briefcase](https://beeware.org/project/projects/tools/briefcase/). They offer
native Windows Installer integration, which is useful for enterprise deployment
via Group Policy.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Has this been tested?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No it hasn't been tested, I removed it for now (13a5933) - it's better to not say anything than to sound fancy about possibly incorrect statements.

@github-project-automation github-project-automation Bot moved this from 🆕 New to ✅ Approved in 🔎 Review May 29, 2026
@lrandersson lrandersson merged commit 5b517d9 into conda:briefcase-integration Jun 1, 2026
22 checks passed
@github-project-automation github-project-automation Bot moved this from ✅ Approved to 🏁 Done in 🔎 Review Jun 1, 2026
lrandersson added a commit that referenced this pull request Jun 1, 2026
lrandersson added a commit that referenced this pull request Jun 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed [bot] added once the contributor has signed the CLA

Projects

Status: 🏁 Done

Development

Successfully merging this pull request may close these issues.

3 participants