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

Add in-app changelog #1208

Merged
merged 7 commits into from
Mar 20, 2024
Merged

Conversation

micahmo
Copy link
Member

@micahmo micahmo commented Mar 15, 2024

Pull Request Description

This PR adds support for an (optional) in-app message and changelog for when the app is updated.

  • This is optional, and while it's on by default, there's a single button which users can press to disable (without having to go into settings).
  • No notification is shown the first time the app launches, only when the version is detected to change.

Issue Being Fixed

Issue Number: N/A

Screenshots / Recordings

Note

In this demo, I have the dialog appearing for every restart of the app so I can demonstrate the settings. In reality, it should only appear when the version has changed.

qemu-system-x86_64_MFeSZNfYs2.mp4

Checklist

  • Did you update CHANGELOG.md?
  • Did you use localized strings where applicable?
  • Did you add semanticLabels where applicable for accessibility?

Copy link
Member

@hjiangsu hjiangsu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it looks good! Just a couple of minor things:

  • For the settings label, we can reword it to "Show Update Changelogs" (the subtitle can be left as is)
  • For the bottom sheet title, we can rename it to display "{version} Release Notes" (e.g., v0.3.0-1 Release Notes). I think that's a bit more concise than what its set to right now!
  • I'm not sure how I feel about having 3 buttons at the bottom. Ideally, I'd like to reduce it down to two ("Close" and "Disable Release Notes"). I did try to experiment with the changes to see if I could use something like a DraggableScrollableSheet so that we don't need to have the "Expand" option, but I wasn't able to get it to work just right. I think we can leave it as is for now (but maybe subject to change in the future)

@micahmo
Copy link
Member Author

micahmo commented Mar 20, 2024

For the settings label, we can reword it to "Show Update Changelogs" (the subtitle can be left as is)

Done! I went ahead and refactored the whole setting to use this new name.

For the bottom sheet title, we can rename it to display "{version} Release Notes" (e.g., v0.3.0-1 Release Notes). I think that's a bit more concise than what its set to right now!

Hmm, we can certainly tweak the wording. I did write it intentionally so that it comes across as an announcement. I think it's pretty common for apps to tell you that they updated, and it's a nice reminder for those who use automatic updates (and maybe don't care as much about the changelog).

If you want to save some room, how about something like this?

image

Otherwise, if you feel strongly about your wording, of course I'll be happy to defer.

I'm not sure how I feel about having 3 buttons at the bottom. Ideally, I'd like to reduce it down to two ("Close" and "Disable Release Notes").

Fair enough! I removed expand/collapse. I did expand the default height a bit as a compromise. Hope that's ok!

image

@hjiangsu
Copy link
Member

Thanks for the changes! I think all of the changes were reasonable!

@hjiangsu hjiangsu merged commit 97f8c6c into thunder-app:develop Mar 20, 2024
1 check passed
@micahmo micahmo deleted the feature/in-app-changelog branch March 20, 2024 15:04
@micahmo
Copy link
Member Author

micahmo commented Mar 20, 2024

Oops, I didn't push the title change. Let me make a new small PR for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants