gotson / komga

Media server for comics/mangas/BDs/magazines/eBooks with API, OPDS and Kobo Sync support
https://komga.org
MIT License
3.89k stars 232 forks source link

[Feature Request] Link to Changelog #691

Closed heisarzola closed 2 years ago

heisarzola commented 3 years ago

Could the version number at the bottom of the side menu be changed to a link to the github changelog/release?

Watchtower updates the docker image for me, but it's hard to tell what changes have been done without checking the latest releases page.

Most would say an in-platform changelog would be ideal, but this should be a nice compromise.

gotson commented 3 years ago

What value would that bring, given you already now where to check for the recent changes?

heisarzola commented 3 years ago

It's far from optimal, and especially slow to check on mobile.

While indeed I do know where to look at, and can even check my watchtower logs to verify that indeed a new update was uploaded (doesn't give me update info there), I'd still need either have the releases page bookmarked (which I don't on all my devices) or in the recent search history, else I'd have to google the github and look for the releases button, sitting through the loading of each new page.

A direct link would just be a click, scroll to check, and that's it.

Of course, this is just an exaggerated breakdown, it's far from grueling or painfully slow, but it's still annoying having to check the changes externally, only to find out it was a routine edge case bug fix or similar type of update.

gotson commented 2 years ago

which link should it point to? The generic releases page, or should it point to the actual release details page, for example if you are running 0.128.0 it would link to this page even if more releases happened since?

KucharczykL commented 2 years ago

Not the original author but I've noticed you already have a CHANGELOG.md file so why not link to that? For example: https://github.com/gotson/komga/blob/master/CHANGELOG.md#01284-2021-09-23 That would always scroll to the correct version but also allow reading all the changes in the same spot.

heisarzola commented 2 years ago

Yea I'd say it'd have to be to either the full releases page, or that md file, the idea just being that you'd just scroll down to view all changes, with the ones at the top being the latest.

Both look fine enough, I'd be more inclined with the the md file for this purpose though, as it's more compact and to the point.

gotson commented 2 years ago

Not the original author but I've noticed you already have a CHANGELOG.md file so why not link to that? For example: https://github.com/gotson/komga/blob/master/CHANGELOG.md#01284-2021-09-23 That would always scroll to the correct version but also allow reading all the changes in the same spot.

the problem with the header links in that changelog is that they need the date too to work

heisarzola commented 2 years ago

https://github.com/gotson/komga/blob/master/CHANGELOG.md should always point to the newest one without the need to make a parser for the part at the end.

gotson commented 2 years ago

https://github.com/gotson/komga/blob/master/CHANGELOG.md should always point to the newest one without the need to make a parser for the part at the end.

yes that's what i will go for

github-actions[bot] commented 2 years ago

:tada: This issue has been resolved in version 0.129.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

KucharczykL commented 2 years ago

A small change but really appreciated, thanks!