Skip to content
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.

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

Make the author name an optional part of the MSI install path #1199

Closed
freakboy3742 opened this issue Apr 20, 2023 · 5 comments · Fixed by #1208
Closed

Make the author name an optional part of the MSI install path #1199

freakboy3742 opened this issue Apr 20, 2023 · 5 comments · Fixed by #1208
Labels
documentation An improvement required in the project's documentation. enhancement New features, or improvements to existing features. good first issue Is this your first time contributing? This could be a good place to start! windows The issue relates to Microsoft Windows support.

Comments

@freakboy3742
Copy link
Member

What is the problem or limitation you are having?

When an MSI installer runs, it installs the app in an AppData/<author name>/<app name> path. This follows the preferred scheme for Microsoft packaging, but it isn't required.

It's not uncommon to see apps packaged in an AppData/<app name> path; and, if a solo developer is building the app, it may be preferable to use this scheme, rather than putting the author's name into the path.

Describe the solution you'd like

A new option use_full_install_path (open to suggestions for a better name) should exist for MSI installers. This will default to True; but if a value of False is specified, the author name will be excluded from the install path.

Describe alternatives you've considered

  1. Do nothing; require the fully qualified install path
  2. Instead of a boolean option, let the user configure everything after the AppData path. e.g., have a install_path setting that defaults to {app.author_name}/{app.formal_name}, but can be explicitly set to anything else the user may want.

I've suggested the boolean option rather than the fully-customised option because the need isn't for full customisation - the install path should always be the app's formal name; it's only a question of whether the author name is included as well.

Additional context

Requested by @davidfokkema on Discord.

@freakboy3742 freakboy3742 added enhancement New features, or improvements to existing features. good first issue Is this your first time contributing? This could be a good place to start! windows The issue relates to Microsoft Windows support. labels Apr 20, 2023
@davidfokkema
Copy link
Contributor

I implemented a fix in beeware/briefcase-windows-app-template#11, but have not yet documented it in briefcase.

@freakboy3742
Copy link
Member Author

@davidfokkema The app template modification looks great; there's a need for an analogous fix on the VisualStudio template.

@freakboy3742
Copy link
Member Author

@davidfokkema Looks like the only piece left is documentation - are you intending to tackle that, or should I open it up for a PyCon US sprint contributor?

@freakboy3742 freakboy3742 added the documentation An improvement required in the project's documentation. label Apr 24, 2023
@davidfokkema
Copy link
Contributor

@davidfokkema Looks like the only piece left is documentation - are you intending to tackle that, or should I open it up for a PyCon US sprint contributor?

I'm looking into that right now!

@davidfokkema
Copy link
Contributor

Thanks for accepting my PRs!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation An improvement required in the project's documentation. enhancement New features, or improvements to existing features. good first issue Is this your first time contributing? This could be a good place to start! windows The issue relates to Microsoft Windows support.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants