release stable (#229)

Author: eagleoflqj

.github/workflows/ci.yml

@@ -4,6 +4,8 @@ on:
   push:
     branches:
       - master
+    tags:
+      - '[0-9]+.*'
   pull_request:
   workflow_dispatch:
 
@@ -112,18 +114,30 @@ jobs:
           path: |
             meta.json
 
+      - name: Generate version.json
+        if: ${{ matrix.arch == 'arm64' && matrix.type == 'Release' }}
+        run: python scripts/generate-version.py
+
+      - name: Upload version.json
+        if: ${{ matrix.arch == 'arm64' && matrix.type == 'Release' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: version.json
+          path: |
+            version.json
+
       - name: Setup tmate session
         if: ${{ failure() }}
         uses: mxschmitt/action-tmate@v3
 
   compare:
-    if: ${{ github.ref != 'refs/heads/master' }}
+    if: ${{ github.event_name == 'pull_request' }}
     needs: build
     uses: ./.github/workflows/compare.yml
 
   release:
     needs: build
-    if: ${{ github.ref == 'refs/heads/master' && !contains(github.event.head_commit.message, '!release') }}
+    if: ${{ github.event_name != 'pull_request' }}
     runs-on: ubuntu-latest
     steps:
       - name: Download artifact
@@ -132,6 +146,7 @@ jobs:
           merge-multiple: true
 
       - name: Create Nightly release
+        if: ${{ github.ref == 'refs/heads/master' }}
         uses: 'marvinpinto/action-automatic-releases@latest'
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
@@ -141,3 +156,15 @@ jobs:
           files: |
             Fcitx5-*.tar.bz2
             meta.json
+            version.json
+
+      - name: Create Stable release
+        if: ${{ github.ref != 'refs/heads/master' }}
+        uses: 'marvinpinto/action-automatic-releases@latest'
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          draft: true
+          prerelease: false
+          title: ${{ github.ref_name }}
+          files: |
+            Fcitx5-*.tar.bz2

.gitignore

@@ -9,3 +9,5 @@ assets/en.lproj/Localizable.strings
 assets/po/base.pot
 meta.swift
 *~
+version.json
+*.pyc

README.md

@@ -6,7 +6,7 @@ English
 
 [Fcitx5](https://github.com/fcitx/fcitx5) input method framework ported to macOS.
 
-Public beta: please download [installer](https://github.com/fcitx-contrib/fcitx5-macos-installer).
+Please download [installer](https://github.com/fcitx-contrib/fcitx5-macos-installer).
 
 ## Build
 Native build on Intel and Apple Silicon is supported.

README.zh-CN.md

@@ -6,4 +6,4 @@
 
 [Fcitx5](https://github.com/fcitx/fcitx5) 输入框架的 macOS 移植。
 
-公测进行中，请下载[安装器](https://github.com/fcitx-contrib/fcitx5-macos-installer/blob/master/README.zh-CN.md)。
+请下载[安装器](https://github.com/fcitx-contrib/fcitx5-macos-installer/blob/master/README.zh-CN.md)。

assets/zh-Hans.lproj/Localizable.strings

@@ -0,0 +1,14 @@
+# 发布新版本
+
+* 确保当前位于和 GitHub 同步的 master 分支，工作树干净。
+* `python scripts/prepare-release.py`，它会
+  * 对当前 commit 打 tag；
+  * 将新版本插入 [version.jsonl](../version.jsonl) 首行；
+  * 更新 [CMakeLists.txt](../CMakeLists.txt) 中的版本号；
+  * 将上述两个文件的更改加入暂存区。
+* `git push origin 版本号`，这会在 GitHub 上创建一个新的 draft release。
+* 编辑更新日志，删除 debug tar，点击 Publish release。
+* 在 [fcitx5-plugins](https://github.com/fcitx-contrib/fcitx5-plugins) 中发布新版插件。
+* 如果下一个版本将抛弃 macOS 的主/次版本，更改 CMakeLists.txt 中 project 的主/次版本和 CMAKE_OSX_DEPLOYMENT_TARGET。
+* 提交更改，`git push origin master`，这将更新 latest 中的 version.json，用户检查更新时将获取到新版信息。
+* 在 [fcitx5-macos-installer](https://github.com/fcitx-contrib/fcitx5-macos-installer) 中发布新版安装包。

docs/release.zh-CN.md

@@ -0,0 +1,19 @@
+import re
+import subprocess
+
+def dollar(command: str):
+    return subprocess.check_output(command, shell=True, text=True).strip()
+
+
+def get_json(tag: str):
+    cmake_osx_deployment_target_line = dollar('grep "set(CMAKE_OSX_DEPLOYMENT_TARGET" CMakeLists.txt')
+    match = re.search(r'CMAKE_OSX_DEPLOYMENT_TARGET ([\d\.]+)\)', cmake_osx_deployment_target_line)
+    if match is None:
+        raise Exception('CMakeLists.txt should set CMAKE_OSX_DEPLOYMENT_TARGET properly.')
+    macos = match.group(1)
+    return {
+        'tag': tag,
+        'macos': macos,
+        'sha': dollar('git rev-parse HEAD'),
+        'time': int(dollar('git show --no-patch --format=%ct'))
+    }

scripts/common.py

@@ -0,0 +1,16 @@
+import json
+from common import get_json
+
+versions = []
+
+with open('version.jsonl') as f:
+    while line := f.readline():
+        versions.append(json.loads(line))
+
+# Generate sha and time for tag latest.
+latest = get_json('latest')
+
+with open('version.json', 'w') as f:
+    json.dump({
+        'versions': [latest] + versions
+    }, f)

scripts/generate-version.py

@@ -0,0 +1,30 @@
+import json
+import os
+import re
+from common import dollar, get_json
+
+def get_version():
+    project_line = dollar('grep "project(fcitx5-macos VERSION" CMakeLists.txt')
+    match = re.search(r'VERSION ([\d\.]+)', project_line)
+    if match is None:
+        raise Exception('CMakeLists.txt should set VERSION properly.')
+    return match.group(1)
+
+version = get_version()
+if os.system(f'git tag -a {version} -m "release {version}"') != 0:
+    raise Exception('Failed to create git tag.')
+
+with open('version.jsonl') as f:
+    content = f.read()
+
+with open('version.jsonl', 'w') as f:
+    json.dump(get_json(version), f)
+    f.write('\n' + content)
+
+major, minor, patch = version.split('.')
+
+if os.system(f'sed -i.bak "s/fcitx5-macos VERSION {major}\\.{minor}\\.{patch}/fcitx5-macos VERSION {major}.{minor}.{int(patch) + 1}/" CMakeLists.txt') != 0:
+    raise Exception('Failed to update version in CMakeLists.txt.')
+os.system('rm CMakeLists.txt.bak')
+
+os.system('git add version.jsonl CMakeLists.txt')

scripts/prepare-release.py

@@ -6,6 +6,10 @@ execute_process(COMMAND git show --no-patch --format=%ct
     OUTPUT_VARIABLE UNIX_TIME
     OUTPUT_STRIP_TRAILING_WHITESPACE
 )
+execute_process(COMMAND bash -c "git describe --exact-match || echo latest"
+    OUTPUT_VARIABLE RELEASE_TAG
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+)
 configure_file(config/meta.swift.in ${CMAKE_CURRENT_SOURCE_DIR}/config/meta.swift @ONLY)
 
 file(GLOB CONFIG_UI_FILES CONFIGURE_DEPENDS config/*.swift)

src/CMakeLists.txt

@@ -32,14 +32,6 @@ func disableInputMethod() {
   }
 }
 
-struct Object: Codable {
-  let sha: String
-}
-
-struct Tag: Codable {
-  let object: Object
-}
-
 enum UpdateState {
   case notChecked  // Clickable "Check update"
   case checking  // Disabled "Checking"
@@ -56,6 +48,7 @@ struct AboutView: View {
   @State private var downloadProgress = 0.0
 
   @State private var showUpToDate = false
+  @State private var showSystemNotSupported = false
   @State private var showCheckFailed = false
   @State private var showDownloadFailed = false
   @State private var showInstallFailed = false
@@ -64,6 +57,7 @@ struct AboutView: View {
   @State private var removeUserData = false
   @State private var uninstalling = false
   @State private var uninstallFailed = false
+  @State private var targetTag: String? = nil
 
   var body: some View {
     VStack {
@@ -87,7 +81,11 @@ struct AboutView: View {
       }
 
       Spacer().frame(height: gapSize)
-      urlButton(String(commit.prefix(7)), sourceRepo + "/commit/" + commit)
+      if releaseTag == "latest" {
+        urlButton(String(commit.prefix(7)), sourceRepo + "/commit/" + commit)
+      } else {
+        urlButton(releaseTag, sourceRepo + "/tree/" + releaseTag)
+      }
 
       Spacer().frame(height: gapSize)
       Text(getDate())
@@ -117,7 +115,7 @@ struct AboutView: View {
           if viewModel.state == .notChecked {
             checkUpdate()
           } else if viewModel.state == .available {
-            update(debug: isDebug)
+            update(debug: isDebug && targetTag == "latest")
           }
         } label: {
           if viewModel.state == .notChecked || viewModel.state == .upToDate {
@@ -144,9 +142,15 @@ struct AboutView: View {
             }
           ) {
             VStack {
-              Text("Update available")
+              if let tag = targetTag {  // Should always be true.
+                if tag == "latest" {
+                  Text("Latest (unstable) version available")
+                } else {
+                  Text("Version \(tag) available")
+                }
+              }
               Button {
-                update(debug: isDebug)
+                update(debug: isDebug && targetTag == "latest")
               } label: {
                 Text("Update now")
               }.buttonStyle(.borderedProminent)
@@ -164,20 +168,21 @@ struct AboutView: View {
           } label: {
             Text("Switch to Release")
           }.disabled(
-            viewModel.state == .downloading || viewModel.state == .installing
+            targetTag == nil || viewModel.state == .downloading || viewModel.state == .installing
           )
         } else {
           Button {
             showSwitchToDebug = true
           } label: {
             Text("Switch to Debug")
           }.disabled(
-            viewModel.state == .downloading || viewModel.state == .installing
+            targetTag != "latest" || viewModel.state == .downloading
+              || viewModel.state == .installing
           ).sheet(
             isPresented: $showSwitchToDebug
           ) {
             VStack {
-              Text("Switch to debug only if Fctix5 crashes and you want to help debug.")
+              Text("Switch to debug only if Fcitx5 crashes and you want to help debug.")
               HStack {
                 Button {
                   showSwitchToDebug = false
@@ -250,6 +255,11 @@ struct AboutView: View {
           displayMode: .hud, type: .complete(Color.green),
           title: NSLocalizedString("Fcitx5 is up to date", comment: ""))
       }
+      .toast(isPresenting: $showSystemNotSupported) {
+        AlertToast(
+          displayMode: .hud, type: .error(Color.red),
+          title: NSLocalizedString("Your system version is no longer supported", comment: ""))
+      }
       .toast(isPresenting: $showCheckFailed) {
         AlertToast(
           displayMode: .hud, type: .error(Color.red),
@@ -292,37 +302,43 @@ struct AboutView: View {
   }
 
   func checkUpdate() {
-    guard
-      // https://api.github.com/repos/fcitx-contrib/fcitx5-macos/git/ref/tags/latest
-      // GitHub API may be blocked in China and is unstable in general.
-      let url = URL(
-        string: "\(sourceRepo)/releases/download/latest/meta.json")
-    else {
-      return
-    }
     viewModel.state = .checking
-    URLSession.shared.dataTask(with: url) { data, response, error in
-      if let data = data,
-        let tag = try? JSONDecoder().decode(Tag.self, from: data)
-      {
-        if tag.object.sha == commit {
-          viewModel.state = .upToDate
-          showUpToDate = true
-        } else {
+    checkMainUpdate { success, latestCompatible, latest, stable in
+      if success {
+        if let stable = stable {
+          // latest >= stable > current
+          targetTag = stable.tag
           viewModel.state = .availableSheet
+        } else {
+          if !latestCompatible {
+            viewModel.state = .upToDate
+            showSystemNotSupported = true
+          } else if latest == nil {
+            // latest == current >= stable
+            viewModel.state = .upToDate
+            showUpToDate = true
+          } else {
+            // latest > current >= stable
+            targetTag = "latest"
+            viewModel.state = .availableSheet
+          }
         }
       } else {
         viewModel.state = .notChecked
         showCheckFailed = true
       }
-    }.resume()
+    }
   }
 
   func update(debug: Bool) {
+    guard let tag = targetTag else {
+      FCITX_ERROR("Calling update with nil tag")
+      return
+    }
     viewModel.state = .downloading
-    checkPluginUpdate({ success, nativePlugins, dataPlugins in
+    checkPluginUpdate(tag) { success, nativePlugins, dataPlugins in
       let updater = Updater(
-        main: true, debug: debug, nativePlugins: nativePlugins, dataPlugins: dataPlugins)
+        tag: tag, main: true, debug: debug, nativePlugins: nativePlugins, dataPlugins: dataPlugins)
       updater.update(
         // Install plugin in a best-effort manner. No need to check plugin status.
         onFinish: { result, _, _ in
@@ -336,7 +352,7 @@ struct AboutView: View {
         onProgress: { progress in
           downloadProgress = progress
         })
-    })
+    }
   }
 
   func install(debug: Bool) {