@mike-fabian
Copy link

https://www.freedesktop.org/software/appstream/docs/sect-Metadata-Releases.html#tag-release-issues

The specification is quite vague about what can be written in the <description> and <issue> tags for a release.

Long ago I wrote long bulleted lists with links to the issues fixed into <description> but then appstreamcli --validate complained, it did not want me to use URLs in the description and I was not able to achieve a nice looking formatted result of the text either. If I remember correctly, list using ul/li did not work in <description>.

Therefore, I changed <description> to only contain a generic message like Bugs fixed and tried to put the detailed information
into the <issue> tags, for example like:

    <release version="2.19.7" date="2022-10-24" urgency="medium">
      <description>
        <p>Bug fixes and enhancements</p>
      </description>
      <url>https://github.com/mike-fabian/ibus-typing-booster/releases/tag/2.19.7</url>
      <issues>
        <issue url="https://github.com/mike-fabian/ibus-typing-booster/issues/395">
          github-issues#395: Avoid inline completion when OSK
          (on-screen-keyboard) is shown
        </issue>

But gnome-software does not display that at all, see:

https://gitlab.gnome.org/GNOME/gnome-software/-/issues/2049#note_1648786

The gnome-software developer Milan Crha and me both think that the specification does not say clearly what exactly to write into the <issue> tags. What I did above seems reasonable to me, but when reading the specification I am not sure whether it is OK like that.

Can you please clarify this?