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)