bumpversion: Update releases in appdata.xml

Using lxml means rewriting the file, which loses comments.

3 files changed, 57 insertions, 99 deletions

diff --git a/.bumpversion.cfg b/.bumpversion.cfg
index 264d51446..aecd732dd 100644
--- a/.bumpversion.cfg
+++ b/.bumpversion.cfg
@@ -7,3 +7,8 @@ tag_name = v{new_version}
 
 [bumpversion:file:qutebrowser/__init__.py]
 parse = __version__ = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)
+
+[bumpversion:file:misc/org.qutebrowser.qutebrowser.appdata.xml]
+search = <!-- Add new releases here -->
+replace = <!-- Add new releases here -->
+          <release version="{new_version}" date="{now:%Y-%m-%d}"/>
diff --git a/misc/org.qutebrowser.qutebrowser.appdata.xml b/misc/org.qutebrowser.qutebrowser.appdata.xml
index d4c4d69e8..4c3f40f54 100644
--- a/misc/org.qutebrowser.qutebrowser.appdata.xml
+++ b/misc/org.qutebrowser.qutebrowser.appdata.xml
@@ -43,56 +43,57 @@
 	<content_rating type="oars-1.1">
 	</content_rating>
 	<releases>
-		<release version="1.6.3" date="2019-06-18"/>
-		<release version="1.6.2" date="2019-05-06"/>
-		<release version="1.6.1" date="2019-03-20"/>
-		<release version="1.6.0" date="2019-02-25"/>
-		<release version="1.5.2" date="2018-10-26"/>
-		<release version="1.5.1" date="2018-10-10"/>
-		<release version="1.5.0" date="2018-10-03"/>
-		<release version="1.4.2" date="2018-09-02"/>
-		<release version="1.4.1" date="2018-07-11"/>
-		<release version="1.4.0" date="2018-07-03"/>
-		<release version="1.3.3" date="2018-06-21"/>
-		<release version="1.3.2" date="2018-06-10"/>
-		<release version="1.3.1" date="2018-05-29"/>
-		<release version="1.3.0" date="2018-05-03"/>
-		<release version="1.2.1" date="2018-03-14"/>
-		<release version="1.2.0" date="2018-03-09"/>
-		<release version="1.1.2" date="2018-03-01"/>
-		<release version="1.1.1" date="2018-01-20"/>
-		<release version="1.1.0" date="2018-01-15"/>
-		<release version="1.0.4" date="2017-11-28"/>
-		<release version="1.0.3" date="2017-11-04"/>
-		<release version="1.0.2" date="2017-10-17"/>
-		<release version="1.0.1" date="2017-10-13"/>
-		<release version="1.0.0" date="2017-10-12"/>
-		<release version="0.11.1" date="2017-10-09"/>
-		<release version="0.11.0" date="2017-07-04"/>
-		<release version="0.10.1" date="2017-03-08"/>
-		<release version="0.10.0" date="2017-02-25"/>
-		<release version="0.9.1" date="2017-01-13"/>
-		<release version="0.9.0" date="2016-12-28"/>
-		<release version="0.8.4" date="2016-11-06"/>
-		<release version="0.8.3" date="2016-11-05"/>
-		<release version="0.8.2" date="2016-08-02"/>
-		<release version="0.8.1" date="2016-07-27"/>
-		<release version="0.8.0" date="2016-07-26"/>
-		<release version="0.7.0" date="2016-06-10"/>
-		<release version="0.6.2" date="2016-04-30"/>
-		<release version="0.6.1" date="2016-04-10"/>
-		<release version="0.6.0" date="2016-04-04"/>
-		<release version="0.5.1" date="2016-01-18"/>
-		<release version="0.5.0" date="2016-01-05"/>
-		<release version="0.4.1" date="2015-09-30"/>
-		<release version="0.4.0" date="2015-09-11"/>
-		<release version="0.3.0" date="2015-06-28"/>
-		<release version="0.2.1" date="2015-04-19"/>
-		<release version="0.2.0" date="2015-04-19"/>
-		<release version="0.1.4" date="2015-03-19"/>
-		<release version="0.1.3" date="2015-02-12"/>
-		<release version="0.1.2" date="2015-01-09"/>
-		<release version="0.1.1" date="2014-12-28"/>
-		<release version="0.1" date="2014-12-14"/>
+<!-- Add new releases here -->
+<release version="1.6.3" date="2019-06-18"/>
+<release version="1.6.2" date="2019-05-06"/>
+<release version="1.6.1" date="2019-03-20"/>
+<release version="1.6.0" date="2019-02-25"/>
+<release version="1.5.2" date="2018-10-26"/>
+<release version="1.5.1" date="2018-10-10"/>
+<release version="1.5.0" date="2018-10-03"/>
+<release version="1.4.2" date="2018-09-02"/>
+<release version="1.4.1" date="2018-07-11"/>
+<release version="1.4.0" date="2018-07-03"/>
+<release version="1.3.3" date="2018-06-21"/>
+<release version="1.3.2" date="2018-06-10"/>
+<release version="1.3.1" date="2018-05-29"/>
+<release version="1.3.0" date="2018-05-03"/>
+<release version="1.2.1" date="2018-03-14"/>
+<release version="1.2.0" date="2018-03-09"/>
+<release version="1.1.2" date="2018-03-01"/>
+<release version="1.1.1" date="2018-01-20"/>
+<release version="1.1.0" date="2018-01-15"/>
+<release version="1.0.4" date="2017-11-28"/>
+<release version="1.0.3" date="2017-11-04"/>
+<release version="1.0.2" date="2017-10-17"/>
+<release version="1.0.1" date="2017-10-13"/>
+<release version="1.0.0" date="2017-10-12"/>
+<release version="0.11.1" date="2017-10-09"/>
+<release version="0.11.0" date="2017-07-04"/>
+<release version="0.10.1" date="2017-03-08"/>
+<release version="0.10.0" date="2017-02-25"/>
+<release version="0.9.1" date="2017-01-13"/>
+<release version="0.9.0" date="2016-12-28"/>
+<release version="0.8.4" date="2016-11-06"/>
+<release version="0.8.3" date="2016-11-05"/>
+<release version="0.8.2" date="2016-08-02"/>
+<release version="0.8.1" date="2016-07-27"/>
+<release version="0.8.0" date="2016-07-26"/>
+<release version="0.7.0" date="2016-06-10"/>
+<release version="0.6.2" date="2016-04-30"/>
+<release version="0.6.1" date="2016-04-10"/>
+<release version="0.6.0" date="2016-04-04"/>
+<release version="0.5.1" date="2016-01-18"/>
+<release version="0.5.0" date="2016-01-05"/>
+<release version="0.4.1" date="2015-09-30"/>
+<release version="0.4.0" date="2015-09-11"/>
+<release version="0.3.0" date="2015-06-28"/>
+<release version="0.2.1" date="2015-04-19"/>
+<release version="0.2.0" date="2015-04-19"/>
+<release version="0.1.4" date="2015-03-19"/>
+<release version="0.1.3" date="2015-02-12"/>
+<release version="0.1.2" date="2015-01-09"/>
+<release version="0.1.1" date="2014-12-28"/>
+<release version="0.1" date="2014-12-14"/>
 	</releases>
 </component>
diff --git a/scripts/dev/update_version.py b/scripts/dev/update_version.py
index 4408050b3..2444e94b9 100644
--- a/scripts/dev/update_version.py
+++ b/scripts/dev/update_version.py
@@ -24,8 +24,6 @@ import datetime
 import os.path
 import subprocess
 
-import lxml.etree
-
 import qutebrowser
 
 sys.path.insert(0, os.path.join(os.path.dirname(__file__), os.pardir,
@@ -33,10 +31,6 @@ sys.path.insert(0, os.path.join(os.path.dirname(__file__), os.pardir,
 
 from scripts import utils
 
-# use basedir to get project root dir
-appdata_path = os.path.join("misc", "org.qutebrowser.qutebrowser.appdata.xml")
-version_xpath = '//*[@type="desktop"]/releases'
-
 
 def bump_version(version_leap="patch"):
     """Update qutebrowser release version.
@@ -49,43 +43,6 @@ def bump_version(version_leap="patch"):
                    check=True)
 
 
-def read_appdata():
-    """Read qutebrowser.appdata.xml into an ElementTree object.
-
-    :Return:
-        ElementTree object representing appdata.xml
-    """
-    with open(appdata_path, "rb") as f:
-        appdata = lxml.etree.fromstring(f.read())
-
-    return appdata
-
-
-def write_appdata(appdata):
-    """Write qutebrowser.appdata ElementTree object to a file.
-
-    Args:
-        appdata: appdata ElementTree object
-    """
-    with open(appdata_path, "wb") as f:
-        f.write(lxml.etree.tostring(appdata, pretty_print=True))
-
-
-def add_release(releases, version_string, date_string):
-    """Add new <release> block to <releases> block of the appdata XML.
-
-    Args:
-        releases: <releases> XML ElementTree
-        version_string: new qutebrowser version
-        date_string: release date for the new version
-    """
-    release = lxml.etree.Element("release")
-    release.attrib["version"] = version_string
-    release.attrib["date"] = date_string
-
-    releases.append(release)
-
-
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(description="Update release version.")
     parser.add_argument('bump', action="store",
@@ -97,11 +54,6 @@ if __name__ == "__main__":
     utils.change_cwd()
     bump_version(args.bump)
 
-    appdata_tree = read_appdata()
-    releases_block = appdata_tree.xpath(version_xpath)[0]
-    add_release(releases_block, version, datetime.date.today().isoformat())
-    write_appdata(appdata_tree)
-
     print("Run the following commands to create a new release:")
     print("* Run `git push origin; git push {v}`.".format(v=version))
     print("* If committing on minor branch, cherry-pick release commit to "