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

[Feature Request] Adding Changelog to About Page in-app #3262

Open
AKASGaming opened this issue Apr 6, 2022 · 13 comments · May be fixed by #6677
Open

[Feature Request] Adding Changelog to About Page in-app #3262

AKASGaming opened this issue Apr 6, 2022 · 13 comments · May be fixed by #6677
Labels
enhancement New feature or request gui Related to Ryujinx.Ui

Comments

@AKASGaming
Copy link

Feature Request

What feature are you suggesting?

Overview:

Adding a section into the app to view the current changelog (or current version changelog)

Why would this feature be useful?

It will provide an easier way to view the changelog rather than going to GitHub or the webpage to check

@edisionnano
Copy link
Contributor

Changelog would probably be nice on the updater too

@MetrosexualGarbodor MetrosexualGarbodor added enhancement New feature or request gui Related to Ryujinx.Ui labels Apr 6, 2022
@voldemort2826
Copy link
Contributor

voldemort2826 commented Apr 9, 2022

The Internet Download Manager's updater could be a useful reference. They parse the txt file from server btw.

Could be possible by parsing the HTML content from the Changelog wiki. I found a JS from here, not familiar with C# so dunno how to integrate this.

@marysaka
Copy link
Contributor

This would be a nice feature to have, but in the current state it's a bit hard.

We will need:

  • An API endpoint to query the changelog (or possibly give the emulator the full changelog and makes it parse it)
  • A process to push changelog information with new version (changelog is constructed after a release is made at the moment)

@sakuka47
Copy link

sakuka47 commented May 7, 2023

A very good idea.
It would allow you to see in real time the maj that has been done.
It may take some time to set up, but once the routine is done, it will become a habit.

I hope one day the Pr will be reopened to do this

@icogniito
Copy link

icogniito commented May 8, 2023

Couldn't the changelog be autoconstructed in the release workflow based on the merged PRs for a given release?
Would ofc require a consistent PR structure that has the needed information.
A cleanup pass could be done manually post release but a preliminary log would fill the gap.

@yell0wsuit
Copy link
Contributor

yell0wsuit commented May 22, 2023

This would be a nice feature to have, but in the current state it's a bit hard.

We will need:

  • An API endpoint to query the changelog (or possibly give the emulator the full changelog and makes it parse it)
  • A process to push changelog information with new version (changelog is constructed after a release is made at the moment)

Actually you can use Github REST API to query for the latest releases (in your release-channel-master repo), then extract the value from the body key. But to do that, you should write (descriptive) changelogs in that repo like you guys always have done in the wiki (otherwise it will show “For more information about this release…”). If possible I will try some C# code and test before opening PR.

@yell0wsuit
Copy link
Contributor

Proof of concept: yell0wsuit#1.

Need the Ryujinx team to update the release description in their release-channel-master repo.

Also need to add a delay about 10-15 min so the team has some time to update the release description, otherwise users will see the very generic description lol.

@gdkchan
Copy link
Member

gdkchan commented May 22, 2023

If we're going to do this, the description should be added on merge, or before. Otherwise I don't think it will work well as someone will inevitably forget to update it. Also there would always be a time gap where there's no description which is also not good.

@MetrosexualGarbodor MetrosexualGarbodor changed the title Adding Changelog to About Page in-app [Feature Request] Adding Changelog to About Page in-app May 22, 2023
@MetrosexualGarbodor
Copy link
Collaborator

need to add a delay about 10-15 min so the team has some time to update the release description

To avoid this, I asked for a kind of semi-automated changelog, where we could type the change and description in advance somewhere and a bot would add the date and version and publish it once the changes are pushed, so the in-emulator changelog could grab that, but I don't even know if that's possible or how much work it would be.

Other emulators just grab the commit name and roll with that, which is probably much easier, but most users won't get much of what it means.

@gdkchan
Copy link
Member

gdkchan commented May 22, 2023

The best thing that I can think right now is that a bot looks for the last message from any repo member with some tag followed by a description. The text would then be used for the release description.

@yell0wsuit
Copy link
Contributor

I decide to revisit this and I seem to get it working, even though it's in the update window (not in the About window).

image

The only problem is that the changelog cannot be localized.

@GamerzHell9137
Copy link

I decide to revisit this and I seem to get it working, even though it's in the update window (not in the About window).

image

The only problem is that the changelog cannot be localized.

The changelogs are not localized so you're fine.

@yell0wsuit
Copy link
Contributor

image

I kinda did it. Will push to Github later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request gui Related to Ryujinx.Ui
Projects
None yet
Development

Successfully merging a pull request may close this issue.

10 participants