search

Nexus-Mods / Vortex

Vortex Development
GNU General Public License v3.0
911 stars 135 forks source link

Allow extensions to provide a changelog/notice on update installation #7990

Open agc93 opened 3 years ago

agc93 commented 3 years ago

Is your feature request related to a problem? Please describe. When an extension update is auto-installed, there is no feedback to users to even inform them which extensions are being updated, let alone what those changes might entail. In my opinion, it would be more helpful to a) at least tell users which extensions are being updated and b) maybe optionally provide a changelog message to be shown to users on update installation.

Describe the solution you'd like I'd like a short message to be displayed to users when an extension is updated that shows which extension has been installed. Ideally, it would be nice to also optionally provide a short changelog message to users, either sourced from the info.json or from the Nexus changelog entries.

Describe alternatives you've considered I understand this can already be done with migrations and I'm totally fine if the answer is "just use migrations", I just wanted to raise this in case there was an easier/nicer way than just using migrations for major updates.

Additional context I'm just noticing this for some major/breaking updates (BeatVortex 0.4.x, AceVortex 0.2.x) where I've already used migrations to achieve this but I'm not sure if that's the right way to do this sort of thing.

IDCs commented 3 years ago

I've also had moments where some 3rd party extension had been updated and I had no idea which one or what changed.

Although migrations can indeed be used to trigger a notification stating what had updated and how, I really think that we could improve the core app to generate these notifications for extension developers. @TanninOne, let us know what you think.

Pickysaurus commented 3 years ago

My thoughts on this. There is a changelog available on the mod page. So perhaps that could be used to pull change information from the API? Obviously, this is a problem from built-in extensions though.

TanninOne commented 3 years ago

Well, using the changelog on the mod page would have the advantage that we'd not be duplicating functionality, unfortunately the api just gives us those changelogs as pre-formatted html so they don't integrate too well into our ui. Still, this is probably our best option.

Using migrations for this would just get excessive, however it may make sense that if you have breaking changes you do point them out separately during migration, because it's quite likely that the regular changelogs will not be read or at least not with a lot of attention.

As for the bundled extensions, their changes are already mentioned in the Vortex changelog, I don't really think we need additional changelogs for them individually.

Pickysaurus commented 3 years ago

As for the bundled extensions, their changes are already mentioned in the Vortex changelog, I don't really think we need additional changelogs for them individually.

The only case where this wouldn't be true is when we issue a game support update between app version releases.