nhcarrigan/hikari-desktop
9
0
Fork 0
generated from nhcarrigan/template
Code Issues 9 Pull Requests 36 Actions Releases 22 Activity

feat: in-app changelog panel #193

New Issue
Closed
opened 2026-03-06 11:30:15 -08:00 by hikari Β· 0 comments
hikari commented 2026-03-06 11:30:15 -08:00
Owner
Copy Link
Copy Source

Overview

Add an in-app changelog panel that displays recent release notes directly within Hikari Desktop, so users can see what's new without leaving the app.

Motivation

Currently users have to check GitHub/Gitea releases or the repository manually to see what changed in a new version. An in-app changelog improves discoverability and helps users understand new features after an update.

Proposed Behaviour

  • A Changelog button in the status bar (e.g. πŸ“‹ or πŸŽ‰ icon)
  • Opens a modal panel listing recent versions and their release notes
  • Fetches release data from the Gitea API (git.nhcarrigan.com/nhcarrigan/hikari-desktop/releases)
  • Shows release tag, date, and body (rendered as markdown)
  • "What's New" badge: on first launch after an update, show a notification dot on the changelog button until the user opens it
    • Compare stored last-seen version (in config or local storage) against current appVersion
    • Clear the badge once the panel is opened

Implementation Notes

  • Use @tauri-apps/api/app getVersion() for the current app version
  • Fetch releases via fetch() from the Gitea API (no auth needed for public repo)
  • Store last_seen_version in the app config (configStore) to track the "new" badge state
  • Render markdown release bodies using the existing markdown renderer (if available) or a simple pre-formatted block
  • Paginate or cap at the last ~10 releases to keep the panel lightweight
  • Cache fetched releases in-session to avoid repeated API calls

Acceptance Criteria

  • Changelog button visible in the status bar
  • Panel opens and displays at least the 10 most recent releases
  • Each entry shows: version tag, release date, release notes
  • Notification dot appears after an update (version mismatch with stored value)
  • Notification dot clears after opening the panel
  • Graceful error state if the API is unreachable (offline mode)
  • Full test coverage for the store logic

✨ This issue was created with help from Hikari~ 🌸

## Overview Add an in-app changelog panel that displays recent release notes directly within Hikari Desktop, so users can see what's new without leaving the app. ## Motivation Currently users have to check GitHub/Gitea releases or the repository manually to see what changed in a new version. An in-app changelog improves discoverability and helps users understand new features after an update. ## Proposed Behaviour - A **Changelog** button in the status bar (e.g. πŸ“‹ or πŸŽ‰ icon) - Opens a modal panel listing recent versions and their release notes - Fetches release data from the Gitea API (`git.nhcarrigan.com/nhcarrigan/hikari-desktop/releases`) - Shows release tag, date, and body (rendered as markdown) - **"What's New" badge**: on first launch after an update, show a notification dot on the changelog button until the user opens it - Compare stored last-seen version (in config or local storage) against current `appVersion` - Clear the badge once the panel is opened ## Implementation Notes - Use `@tauri-apps/api/app` `getVersion()` for the current app version - Fetch releases via `fetch()` from the Gitea API (no auth needed for public repo) - Store `last_seen_version` in the app config (`configStore`) to track the "new" badge state - Render markdown release bodies using the existing markdown renderer (if available) or a simple pre-formatted block - Paginate or cap at the last ~10 releases to keep the panel lightweight - Cache fetched releases in-session to avoid repeated API calls ## Acceptance Criteria - [ ] Changelog button visible in the status bar - [ ] Panel opens and displays at least the 10 most recent releases - [ ] Each entry shows: version tag, release date, release notes - [ ] Notification dot appears after an update (version mismatch with stored value) - [ ] Notification dot clears after opening the panel - [ ] Graceful error state if the API is unreachable (offline mode) - [ ] Full test coverage for the store logic ✨ This issue was created with help from Hikari~ 🌸
naomi closed this issue 2026-03-07 03:08:34 -08:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
aspect
code
Concerns the software code in the repository
aspect
dx
Concerns developers' experience with the codebase
aspect
interface
Concerns end-users' experience with the software
aspect
text
Concerns the documentation material in the repository
contribute
good first issue
A great opportunity for a team member to learn a new codebase
contribute
help wanted
Open for anyone on our team to grab.
contribute
staff only
Restricted to our executive leadership.
goal
addition
Addition of new feature
goal
fix
Bug fix
goal
improvement
Improvement to an existing feature
points
1
Very simple issue requiring minimal effort and complexity.
points
13
Extremely complex issue representing major undertakings. Should be broken down into smaller pieces.
points
2
Simple issue that requires a bit more thought or investigation.
points
3
Moderate complexity issue requiring more substantial work.
points
5
Complex issue requiring significant effort and expertise.
points
8
Very complex issue requiring extensive work and deep expertise.
priority
critical
1
Must be fixed ASAP
priority
high
2
Stalls work on the project or its dependents
priority
low
4
Low priority and doesn't need to be rushed
priority
medium
3
Not blocking but should be fixed soon
priority
none
5
No priority, should only be performed when a developer is available
status
awaiting triage
Has not been triaged & therefore, not ready for work
status
blocked
Blocked and therefore not ready for work
status
discarded
Will not be worked on
status
discontinued
Not suitable for work as repo is in maintenance
status
label work required
Needs proper labelling before it can be worked on
status
ready for dev
Ready for work
status
ticket work required
Needs more details before it can be worked on
talk
discussion
Open for discussions and feedback
talk
question
Can be resolved with an answer
time
1 day
Approximately one full day of development work.
time
1-2 weeks
One to two weeks of focused development effort.
time
2-3 days
Two to three days of development effort.
time
4-5 days
Approximately one week of development work.
time
<1 day
Less than one day of focused work. Quick fixes or simple tasks.
time
>2 weeks
More than two weeks of development work. Must be broken down into smaller pieces.
No Label
Milestone
No items
No Milestone
Assignees
Clear assignees
gurkirat hanna (Hanna Rose) hikari (Hikari) minori (Minori) naomi (Naomi Carrigan) rain teklu tim
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: nhcarrigan/hikari-desktop#193
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?