[Feature] Update registry entries

[Advaith3600]

I am currently using this for my currency converter plugin, and it works wonderfully. I just have one suggestion: please update the registry entries. I am adding a system registry entry during installation, which allows users to quickly uninstall the plugin and view its details through the Control Panel or the Installed Apps page in Settings. Therefore, during updates, it would be beneficial if the updater could modify this registry entry to reflect the new version.

Thank you!

[hlaueriksson]

I'm not sure what you mean by "registry entries".

[Advaith3600]

I meant the Windows registry. Currently, my EXE file is creating a registry entry at HKLM\Software\Microsoft\Windows\CurrentVersion\Uninstall\CurrencyConverter\DisplayVersion. It would be great if the updater could update the version here during the update.

[hlaueriksson]

This project has no idea about Windows Registry updates.

However, your plugin can listen to the UpdateInstalled event:

Community.PowerToys.Run.Plugin.Update/src/Community.PowerToys.Run.Plugin.Update/PluginUpdateHandler.cs

Line 24 in 08da574

event EventHandler<PluginUpdateEventArgs>? UpdateInstalled;

Example:

Community.PowerToys.Run.Plugin.Update/samples/Community.PowerToys.Run.Plugin.Sample/Main.cs

Lines 191 to 195 in 08da574

	private void OnUpdateInstalled(object? sender, PluginUpdateEventArgs e)
	{
	Log.Info("UpdateInstalled: " + e.Version, GetType());
	Context!.API.ShowNotification($"{Name} {e.Version}", "Update installed");
	}

☝️ Add updates to the Registry here.

[Advaith3600]

I don't think a system-level modification for an update should be handled in the plugin itself, and I believe elevation is also required to run it, making it more suitable to be done at an updater level.

# rest of the code

Write-Log "Extract release"
$parent = Split-Path -Path $pluginDirectory -Parent
Expand-Archive -Path $release -DestinationPath $parent -Force

Write-Log "Update registry version"
$registryPath = "HKLM:\Software\Microsoft\Windows\CurrentVersion\Uninstall\$name"
if (Test-Path $registryPath) {
    Set-ItemProperty -Path $registryPath -Name "DisplayVersion" -Value $newVersion
    Write-Log "Registry version updated to $newVersion"
}
else {
    Write-Warning "Registry path not found: $registryPath"
}

[hlaueriksson]

I don't think this project should know anyting about the Windows Registry.

I'm open for a way for plugin authors to include a post upgrade script that is invoked at the end of update.ps1.
It would be a more generic solution.

For example:

1. The plugin includes a script, e.g. postupdate.ps1

2. The PluginUpdateSettings could have a property public string? PostUpdateScriptPath { get; set; }

3. The plugin could set the property here:

Community.PowerToys.Run.Plugin.Update/samples/Community.PowerToys.Run.Plugin.Sample/SampleSettings.cs

Line 14 in 08da574

public PluginUpdateSettings Update { get; set; } = new PluginUpdateSettings { ResultScore = 100 };

4. The PluginUpdateHandler adds the PostUpdateScriptPath param here:

Community.PowerToys.Run.Plugin.Update/src/Community.PowerToys.Run.Plugin.Update/PluginUpdateHandler.cs

Line 261 in 08da574

var arguments = $"-ExecutionPolicy Bypass -File \"{Metadata.PluginDirectory}\\update.ps1\" \"{LatestAsset.browser_download_url}\"";

5. The update.ps1 invokes the post upgrade script after these lines:

Community.PowerToys.Run.Plugin.Update/src/Community.PowerToys.Run.Plugin.Update/update.ps1

Lines 119 to 121 in 08da574

	Write-Log "Extract release"
	$parent = Split-Path -Path $pluginDirectory -Parent
	Expand-Archive -Path $release -DestinationPath $parent -Force

Perhaps support for a pre upgrade script would also be of interest to plugin authors!?