search

ynput / ayon-frontend

Codebase of AYON server web interface
Apache License 2.0
17 stars 14 forks source link

Market: Addon changelogs between versions #412

Open Innders opened 5 months ago

Innders commented 5 months ago

Story

An admin wants to update an addon but needs to check what has changed.

Proposal

TODO

Attachments

Marketplace_Selected_v003
BigRoy commented 5 months ago

Based on the screenshot I just want to remark that it's also very valuable to see the changelogs across multiple versions instead of just the last one. I'm not saying this page may be the good place for that but I really love changelog pages where I can just "CTRL+F" to find certain keywords across 1.x.x releases to see which release versions touched that area and may have affected a bug I'm having or has introduced a fix for a reported issue, etc.

Here are some examples:

Opposite to that take e.g. this where I need to click into each version to see what changes it made taking me more time to find a particular feature:

Where separate pages are worth it totally depends on how frequent releases are made. When more frequent having them easily accessible and searchable in one place instead of having to click through each version for details is a major help. I feel like AYON addons tend to be on the higher end of 'version release cycles' so we might want to keep this UX in mind.

Innders commented 5 months ago

I totally get your point and those are some great examples.

Maybe my description/design wasn't clear enough.

The idea is that you will be shown the changelog for every version between the selected (in market) and your current version. Is it fair to assume you don't need to know the changes for versions before your current one?

Actually that makes me think... should this be a comparison to the highest downloaded version or the version used in the production bundle?

Side note: we are changing the naming from "Installed" to "Downloaded" on the addon page: #415

BigRoy commented 5 months ago

I feel like the changelog in the marketplace could be changes between that version and maybe the highest downloaded/local one or the production one. Don't have an opinion there.

But still I'd love to be able to click somewhere to get to a changelog list as explained above, including older versions so that I could also know to which version to potentially downgrade to if a particular bug started occurring.

Innders commented 5 months ago

Does this updated design help at all? (Also updated in description)

Marketplace_Selected_v003
BigRoy commented 5 months ago

Yes, perfect - especially if full changelog points to a page that also has the bullet points for 0.1.0, 0.0.9, etc. so that they are available at least somewhere on a full page.

Innders commented 3 months ago

Right now there is no changelog data provided to addons when they are released. The only thing available is the github release notes.

I can't see there being a solution anytime soon so I propose a intermediate step of showing links to these release notes on github. I would have liked to have these notes inside of AYON but the CI isn't even close to getting there.

Here is a new design below.

image

https://github.com/user-attachments/assets/c6aeb8c1-6291-4a7e-a159-9d2f637dce16