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

feat(ui): release notes modal #1345

Open
wants to merge 19 commits into
base: main
Choose a base branch
from

Conversation

peps
Copy link
Collaborator

@peps peps commented Jan 3, 2025

This adds a Release Notes modal that pops up after a new app version is detected.

CleanShot 2025-01-03 at 13 54 47

Functionality requirements:

  • Only show the popup if the app version and fetched release notes version are a match.
  • Only show the popup once per version.
  • Only fetch the release notes on startup if the versions are not a match

@peps peps self-assigned this Jan 3, 2025
@peps peps marked this pull request as ready for review January 7, 2025 20:05
@peps peps marked this pull request as draft January 7, 2025 20:15
@peps peps changed the title feat(ui): release notes modal - wip feat(ui): release notes modal Jan 7, 2025
@peps peps marked this pull request as ready for review January 7, 2025 20:40

export default function Setup() {
useSetUp();
useReleaseNotes({ triggerEffect: true });
Copy link
Collaborator

Choose a reason for hiding this comment

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

LGTM & tested locally with the admin trigger

just a bit concerned about this one in during setup and how it will react with auto update stuff? 😅 might be good for @mmrrnn to have a look through too

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@shanimal08 good point, I can move the trigger for the modal to happen after setup completes. That way it wont conflict with the updater.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Why not to invoke check_for_updates to ensure there is no update available?

Copy link
Collaborator

Choose a reason for hiding this comment

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

We can also add it to the get_last_changelog_version response

Copy link
Collaborator Author

@peps peps Jan 15, 2025

Choose a reason for hiding this comment

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

@mmrrnn I moved it to the MainView so it shouldn't conflict with the Updater anymore.

One weird requirement for this is that CHANGELOG.md might not be updated in time for a release. So this will pop only when the latestVersion in CHANGELOG.md ( fetched from github main ) matches the appVersion number, and when latestVersion does not equal get_last_changelog_version

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yeah, that's fine 👍

@shanimal08 shanimal08 requested a review from mmrrnn January 15, 2025 13:26
@peps peps requested a review from brianp January 15, 2025 17:31
@peps
Copy link
Collaborator Author

peps commented Jan 15, 2025

@brianp @shanimal08 I've updated the modal to trigger in MainView instead of Setup, so it should no longer conflict with the update modal.

I also updated the Markdown styles for the latest release notes

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.

6 participants