Always create description tag

flathub-infra · Nov 8, 2023 · e0b0b79 · e0b0b79
1 parent 0f5999b
commit e0b0b79
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 10 deletions.
diff --git a/src/lib/appdata.py b/src/lib/appdata.py
@@ -83,6 +83,12 @@ def add_release(
     releases.insert(0, release)
     _fill_padding(release)
 
+    description = ElementTree.Element("description")
+    description.text = ""
+
+    release.append(description)
+    _fill_padding(description)
+
     tree.write(
         dst,
         # XXX: lxml uses single quotes for doctype line if generated with

diff --git a/tests/test_appdata.py b/tests/test_appdata.py
@@ -46,7 +46,9 @@ def test_simple(self):
 <?xml version="1.0" encoding="UTF-8"?>
 <component type="desktop">
   <releases>
-    <release version="4.5.6" date="2020-02-02"/>
+    <release version="4.5.6" date="2020-02-02">
+      <description></description>
+    </release>
     <release version="1.2.3" date="2019-01-01"/>
   </releases>
 </component>
@@ -70,7 +72,9 @@ def test_mixed_indentation(self):
 <?xml version="1.0" encoding="UTF-8"?>
 <component type="desktop">
    <releases>
-      <release version="4.5.6" date="2020-02-02"/>
+      <release version="4.5.6" date="2020-02-02">
+        <description></description>
+      </release>
       <release version="1.2.3" date="2019-01-01"/>
        <release version="1.2.3" date="2019-01-01"/>
    </releases>
@@ -119,7 +123,9 @@ def test_comment(self):
 <component type="desktop">
   <!-- I am the walrus -->
   <releases>
-    <release version="4.5.6" date="2020-02-02"/>
+    <release version="4.5.6" date="2020-02-02">
+      <description></description>
+    </release>
     <release version="1.2.3" date="2019-01-01"/>
   </releases>
 </component>
@@ -137,14 +143,16 @@ def test_no_releases(self):
 <?xml version="1.0" encoding="UTF-8"?>
 <component type="desktop">
   <releases>
-    <release version="4.5.6" date="2020-02-02"/>
+    <release version="4.5.6" date="2020-02-02">
+      <description></description>
+    </release>
   </releases>
 </component>
             """.strip(),
         )
 
     def test_empty_releases(self):
-        """No whitespace is generated between <release /> and </releases>."""
+        """No whitespace is generated between </release> and </releases>."""
         self._do_test(
             """
 <?xml version="1.0" encoding="UTF-8"?>
@@ -156,7 +164,9 @@ def test_empty_releases(self):
 <?xml version="1.0" encoding="UTF-8"?>
 <component type="desktop">
   <releases>
-    <release version="4.5.6" date="2020-02-02"/>
+    <release version="4.5.6" date="2020-02-02">
+      <description></description>
+    </release>
   </releases>
 </component>
             """.strip(),
@@ -186,7 +196,9 @@ def test_double_comment_within_root(self):
 -->
   <name>First element needed</name>
   <releases>
-    <release version="4.5.6" date="2020-02-02"/>
+    <release version="4.5.6" date="2020-02-02">
+      <description></description>
+    </release>
   </releases>
 </application>
             """.strip(),
@@ -219,7 +231,9 @@ def test_comment_outside_root(self):
 -->
 <application>
   <releases>
-    <release version="4.5.6" date="2020-02-02"/>
+    <release version="4.5.6" date="2020-02-02">
+      <description></description>
+    </release>
   </releases>
 </application>
             """.strip(),
@@ -238,7 +252,9 @@ def test_amp_as_amp(self):
 <component type="desktop">
   <name>🍦 &amp; 🎂</name>
   <releases>
-    <release version="4.5.6" date="2020-02-02"/>
+    <release version="4.5.6" date="2020-02-02">
+      <description></description>
+    </release>
   </releases>
 </component>
             """.strip(),
@@ -259,7 +275,9 @@ def test_amp_as_codepoint(self):
 <component type="desktop">
   <name>🦝 &#38; 🍒</name>
   <releases>
-    <release version="4.5.6" date="2020-02-02"/>
+    <release version="4.5.6" date="2020-02-02">
+      <description></description>
+    </release>
   </releases>
 </component>
             """.strip(),