Include changelogs in appstream metadata #2407

Open
opened 2026-02-20 22:06:12 -05:00 by deekerman · 0 comments
Owner

Originally created by @Gert-dev on GitHub (Jan 22, 2022).

Context

This was extracted from https://github.com/mumble-voip/mumble/pull/5468#discussion_r787403248.

Description

The appstream metadata in scripts/info.mumble.Mumble.appdata.xml can contain actual changelogs to display to users when updates happen. It would be neat if this could be added.

Since the changelog seems to be based on commits, and this might be easy to forget since it's Linux-specific, it might be interesting to have a task that does this automatically when a new version is tagged/released (e.g. in CI). This work might also be used to embed the changelog in Mumble itself, as alluded to by @Krzmbrzl in https://github.com/mumble-voip/mumble/pull/5468#discussion_r790152971.

Mumble component

Both

OS-specific?

Yes

Additional information

I looked up an example of the changelog entries and the visualization for your convenience: the app Wike is packaged on Flathub, much like Mumble is. As you can see on their Flathub page, there is a subsection Changes in version 1.7.0. This is generated from the above appdata/metadata, which was added in github.com/hugolabe/Wike@cdc4a03bf8 (diff-639412837).

Similarly, package manager front ends or installers such as GNOME Software used on desktops (and smartphones such as the Librem Phone) can also show these same changelogs when notifying of updates, I believe, as already alluded to above.

Originally created by @Gert-dev on GitHub (Jan 22, 2022). ### Context This was extracted from https://github.com/mumble-voip/mumble/pull/5468#discussion_r787403248. ### Description The appstream metadata in `scripts/info.mumble.Mumble.appdata.xml` can contain actual changelogs to display to users when updates happen. It would be neat if this could be added. Since the changelog seems to be based on commits, and this might be easy to forget since it's Linux-specific, it might be interesting to have a task that does this automatically when a new version is tagged/released (e.g. in CI). This work might also be used to embed the changelog in Mumble itself, as alluded to by @Krzmbrzl in https://github.com/mumble-voip/mumble/pull/5468#discussion_r790152971. ### Mumble component Both ### OS-specific? Yes ### Additional information I looked up an example of the changelog entries and the visualization for your convenience: the app [Wike](https://github.com/hugolabe/Wike) is [packaged on Flathub](https://flathub.org/apps/details/com.github.hugolabe.Wike), much [like Mumble is](https://flathub.org/apps/details/info.mumble.Mumble). As you can see on their Flathub page, there is a subsection `Changes in version 1.7.0`. This is generated from the above appdata/metadata, which was added in https://github.com/hugolabe/Wike/commit/cdc4a03bf8d2f90179c74aacf6c3b01d0cf014d7#diff-639412837ed817958642a0e0950e41161a4ddd80acedcd54a3a6e61f07375b21. Similarly, package manager front ends or installers such as GNOME Software used on desktops (and smartphones such as the Librem Phone) can also show these same changelogs when notifying of updates, I believe, as already alluded to above.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/mumble-mumble-voip#2407
No description provided.