Skip to content

Document desktop shortcut behavior as tri-state optional #2953

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mhsmith merged 1 commit into from
Jul 22, 2026
Merged

Document desktop shortcut behavior as tri-state optional #2953

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion changes/2914.feature.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
MSI installers now have a toggle to create a desktop shortcut. The default choice is controlled by the `create_desktop_shortcut` configuration.
MSI installers can now provide the option to create a desktop shortcut using the [`create_desktop_shortcut`][] option.
11 changes: 10 additions & 1 deletion docs/en/reference/platforms/windows/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,16 @@ However, if you need to override this default value, you can define [`version_tr

### `create_desktop_shortcut`

Whether the installer should default to creating a desktop shortcut. Defaults to `False`.
/// note | Only used for MSI packaging
///

Windows MSI installers are able to provide an option to the user to create a desktop shortcut to start the application.

If this setting is set to `True`, the installer will include a checkbox, enabled by default. The user installing the app can then opt out of creating a desktop shortcut for the app.

If this setting is set to `False`, the installer will include the checkbox, but it will be *disabled* by default. The user installing the app can then opt into creating a desktop shortcut for the app.

If this setting is undefined, or set to an empty string, the installer will not include an option to create a shortcut, and no shortcut will be created.

## Installer/uninstaller options

Expand Down