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

Plugin upgrade behavior is undefined #4

Open
frazierjason opened this issue Jan 11, 2023 · 1 comment
Open

Plugin upgrade behavior is undefined #4

frazierjason opened this issue Jan 11, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@frazierjason
Copy link
Owner

frazierjason commented Jan 11, 2023

This plugin author couldn't find any TouchPortal developer documentation that outlines what happens when the same plugin .tpp file is reimported when it was already installed before (whether same version, newer version, or downgrade). Therefore, the behavior is undefined.

Anecdotally, it works fine, but sometimes in development the currently running plugin instance doesn't stop in time, and TP doesn't actually get it uninstalled correctly when over-installing the new one. This results in the reinstall failing to complete. The workaround is to just reinstall it again. It can be avoided by first going to the plugin settings and stopping the plugin instance, before doing the upgrade.

All issues can be avoided by opening the TP application settings, going to Plugin section, select this plugin on the right, and use the trash can icon to uninstall. The next import will be successful, and you won't lose any settings (you will lose your old plugin debug logs though).

@frazierjason frazierjason added help wanted Extra attention is needed documentation Improvements or additions to documentation and removed help wanted Extra attention is needed labels Jan 11, 2023
@frazierjason
Copy link
Owner Author

TouchPortal plugin-general chat on Discord indicates that a reinstall of the same plugin name will completely replace the plugin's folder contents. As stated above, informally it should work, but if any trouble arises, safest to uninstall and reinstall the plugin (all settings will be retained automatically).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant