automatically update files for weasel when needed

Author: fxliang

.github/workflows/gh-pages.yml

@@ -36,7 +36,9 @@ jobs:
 
       - run: npm ci
 
-      - run: python ./weasel_testing_appcast.py
+      - run: |
+          pip install ruamel.yaml
+          python ./update_weasel_appcast.py
 
       - name: Deploy luna pinyin and stroke
         uses: rimeinn/deploy-schema@master

blog/update_weasel_appcast.py

@@ -0,0 +1,163 @@
+import requests
+import time
+from datetime import datetime, timedelta, timezone
+
+datas = []
+for url in ["https://api.github.com/repos/rime/weasel/releases/tags/latest", "https://api.github.com/repos/rime/weasel/releases/latest"]:
+    response = requests.get(url)
+    if response.ok:
+        datas.append(response.json())
+filenames = []
+urls = []
+update_time = []
+tags_name = []
+for data in datas:
+    if data["prerelease"] == False:
+        release_json = data
+    for asset in data['assets']:
+        if asset['name'].endswith('.exe'):
+            filenames.append(asset['name'])
+            urls.append(asset['browser_download_url'])
+            update_time.append(data['published_at'])
+            tags_name.append(data['tag_name'])
+# compare update_time and get the latest one
+latest_time = update_time[0]
+latest_index = 0
+for i in range(1, len(update_time)):
+    if update_time[i] > latest_time:
+        latest_time = update_time[i]
+        latest_index = i
+# get version number
+version = filenames[latest_index].replace("-installer.exe", "")
+version = version.replace("weasel-", "")
+# download url
+download_url = urls[latest_index]
+# get local time in format like "Thu, 01 Jan 1970 00:00:00 +0000"
+# define a function to format time
+def format_time(time_str):
+    utc_offset_sec = -time.timezone if time.localtime().tm_isdst == 0 else -time.altzone
+    utc_offset = timedelta(seconds=utc_offset_sec)
+    current_tz = timezone(utc_offset)
+    utc_time = datetime.strptime(time_str, "%Y-%m-%dT%H:%M:%SZ").replace(tzinfo=timezone.utc)
+    local_time = utc_time.astimezone(current_tz)
+    formatted_time = local_time.strftime("%a, %d %b %Y %H:%M:%S %z")
+    return formatted_time
+formatted_time = format_time(update_time[latest_index])
+
+# get release notes link
+if tags_name[latest_index] == "latest":
+    releaseNotesLink = "https://github.com/rime/weasel/releases/tag/latest"
+else:
+    releaseNotesLink = "http://rime.github.io/testing/weasel/"
+# format xml file content
+template = f"""<?xml version="1.0" encoding="utf-8"?>
+<rss version="2.0" xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle">
+<channel>
+    <title>【小狼毫】輸入法測試頻道</title>
+    <link>http://rime.github.io/testing/weasel/appcast.xml</link>
+    <description>小狼毫測試版 Appcast 更新頻道</description>
+    <language>zh</language>
+    <item>
+      <title>小狼毫 {version}</title>
+      <sparkle:releaseNotesLink>{releaseNotesLink}</sparkle:releaseNotesLink>
+      <pubDate>{formatted_time}</pubDate>
+      <enclosure url="{download_url}"
+                 sparkle:version="{version}"
+                 type="application/octet-stream"/>
+    </item>
+  </channel>
+</rss>
+"""
+print(f"./source/testing/weasel/appcast.xml:\n{template}")
+# write template to ./source/testing/weasel/appcast.xml
+with open("./source/testing/weasel/appcast.xml", "w", encoding='utf-8') as f:
+    f.write(template)
+    f.close()
+    print("./source/testing/weasel/appcast.xml updated\n")
+# update release appcast.xml automatically, and update other files if needed
+if 'release_json' in locals() or 'release_json' in globals():
+    import re
+    release_formatted_time = format_time(release_json['published_at'])
+    # get release url
+    for asset in release_json['assets']:
+        if asset['name'].endswith('.exe'):
+            release_url = asset['browser_download_url']
+            break
+    if 'release_url' not in locals():
+        print("release_url not found, using default url")
+        release_url = f"https://github.com/rime/weasel/releases/download/{release_json["tag_name"]}/weasel-{release_json["tag_name"]}.0-installer.exe"
+    # update appcast.xml
+    template_release = f"""<?xml version="1.0" encoding="utf-8"?>
+    <rss version="2.0" xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle">
+    <channel>
+        <title>【小狼毫】輸入法更新頻道</title>
+        <link>http://rime.github.io/release/weasel/appcast.xml</link>
+        <description>小狼毫 Appcast 更新頻道</description>
+        <language>zh</language>
+        <item>
+        <title>小狼毫 {release_json["tag_name"]}</title>
+        <sparkle:releaseNotesLink>http://rime.github.io/release/weasel/</sparkle:releaseNotesLink>
+        <pubDate>{release_formatted_time}</pubDate>
+        <enclosure url="{release_url}"
+                    sparkle:version="{release_json["tag_name"]}"
+                    type="application/octet-stream"/>
+        </item>
+    </channel>
+    </rss>"""
+    print(f"./source/release/weasel/appcast.xml:\n{template_release}")
+    with open("./source/release/weasel/appcast.xml", "w", encoding='utf-8') as f:
+        f.write(template_release)
+        f.close()
+        print("./source/release/weasel/appcast.xml updated\n")
+    # get changelog.md
+    changelog_url = f"https://raw.githubusercontent.com/rime/weasel/refs/tags/{release_json['tag_name']}/CHANGELOG.md"
+    changelog_txt = requests.get(changelog_url).text
+    match = re.search(r'(\d+\.\d+\.\d+)', changelog_txt)
+    if not match:
+        print("No version number found in CHANGELOG.md")
+        exit(0)
+    changelog_version = match.group(1)
+
+    if changelog_version != release_json['tag_name']:
+        print("latest version in CHANGELOG.md is not released yet")
+        exit(0)
+    # version tag in CHANGELOG.md has been released
+    print("latest version in CHANGELOG.md has been released")
+    index_md = f"""title: 【小狼毫】更新日誌\ncomments: false\ndate: {release_formatted_time}\n---\n\n{changelog_txt}"""
+    # update ./source/release/weasel/index.md
+    with open("./source/release/weasel/index.md", "w", encoding='utf-8') as f:
+        f.write(index_md)
+        f.close()
+        print("./source/release/weasel/index.md updated")
+    # update ./source/testing/weasel/index.md
+    with open("./source/testing/weasel/index.md", "w", encoding='utf-8') as f:
+        f.write(index_md)
+        f.close()
+        print("./source/testing/weasel/index.md updated")
+    # modify ./source/_data/downloads.yaml, key weasel/version and weasel/url
+    from ruamel.yaml import YAML
+    yaml = YAML()
+    yaml.preserve_quotes = True
+    yaml.indent(mapping=2, sequence=2, offset=2)
+    # this will be like this until there is some change in the yaml file not in this format/rule
+    with open("./source/_data/downloads.yaml", "r", encoding='utf-8') as f:
+        downloads_yaml = yaml.load(f)
+        f.close()
+    with open("./source/_data/downloads.yaml", "w", encoding='utf-8') as f:
+        downloads_yaml['weasel']['version'] = release_json['tag_name']
+        downloads_yaml['weasel']['url'] = release_url
+        yaml.dump(downloads_yaml, f)
+        print("./source/_data/downloads.yaml updated")
+        f.close()
+    # update source/download/index.md
+    pattern = r"\* \[小狼毫 \d+\.\d+\.\d+\]\(https://github\.com/rime/weasel/releases/latest\)〔\[下載\]\(https://github\.com/rime/weasel/releases/download/\d+\.\d+\.\d+/weasel-\d+\.\d+\.\d+\.0-installer\.exe\)〕〔\[更新日誌\]\(/release/weasel/\)〕〔\[歷史版本\]\(https://github\.com/rime/weasel/releases\)〕"
+    new_str = f"* [小狼毫 {release_json['tag_name']}](https://github.com/rime/weasel/releases/latest)〔[下載](https://github.com/rime/weasel/releases/download/{release_json['tag_name']}/weasel-{release_json['tag_name']}.0-installer.exe)〕〔[更新日誌](/release/weasel/)〕〔[歷史版本](https://github.com/rime/weasel/releases)〕"
+    # replace pattern with new_str in ./source/download/index.md
+    with open("./source/download/index.md", "r", encoding='utf-8') as f:
+        download_md = f.read()
+        f.close()
+    download_md = re.sub(pattern, new_str, download_md)
+    with open("./source/download/index.md", "w", encoding='utf-8') as f:
+        f.write(download_md)
+        f.close()
+        print("./source/download/index.md updated")