Merge pull request #7 from SHIINASAMA/dev-updater

Unify cross-platform update flow (macOS self-update still disabled)

Author: SHIINASAMA

.github/workflows/release.yml

@@ -11,6 +11,9 @@ on:
 permissions:
   contents: write
 
+env:
+  APP_NAME: App
+
 jobs:
   check-version:
     runs-on: ubuntu-latest
@@ -51,7 +54,7 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
+          python-version: "3.11"
       - uses: yezz123/setup-uv@v4
 
       - name: Before script (Linux)
@@ -76,29 +79,39 @@ jobs:
         if: runner.os == 'macOS'
         run: |
           brew install create-dmg
-          xattr -cr build/*.app
-          create-dmg --volname App --window-pos 200 120 --window-size 600 400 --icon-size 100 --app-drop-link 450 185 App.dmg ./build/*.app
+          xattr -cr build/${{ env.APP_NAME }}.app
+          ./build-dmg.sh
+          mkdir -p release
+          cd build
+          zip -r \
+            ../release/${{ env.APP_NAME }}-${{ matrix.name }}-${{ matrix.arch }}-${{ github.ref_name }}.zip \
+            ${{ env.APP_NAME }}.app/
 
       - name: Package artifact (Linux)
         if: runner.os == 'Linux'
         run: |
-          mv ./build/App ./Package
-          zip -r App-${{ matrix.name }}-${{ matrix.arch }}.zip Package/
+          mv ./build/${{ env.APP_NAME }} ./build/${{ env.APP_NAME }}-${{ matrix.name }}-${{ matrix.arch }}
+          mkdir -p release
+          cd build
+          zip -r \
+            ../release/${{ env.APP_NAME }}-${{ matrix.name }}-${{ matrix.arch }}-${{ github.ref_name }}.zip \
+            ${{ env.APP_NAME }}-${{ matrix.name }}-${{ matrix.arch }}/
 
       - name: Package artifact (Windows)
         if: runner.os == 'Windows'
         shell: pwsh
         run: |
-          Move-Item -Path ./build/App -Destination ./Package
-          Compress-Archive -Path .\Package\ -DestinationPath App-${{ matrix.name }}-${{ matrix.arch }}.zip
+          Move-Item -Path ./build/${{ env.APP_NAME }} -Destination ./build/${{ env.APP_NAME }}-${{ matrix.name }}-${{ matrix.arch }}
+          New-Item -ItemType Directory -Path release
+          Compress-Archive -Path ./build/${{ env.APP_NAME }}-${{ matrix.name }}-${{ matrix.arch }} `
+            -DestinationPath ./release/${{ env.APP_NAME }}-${{ matrix.name }}-${{ matrix.arch }}-${{ github.ref_name }}.zip
 
       - name: Upload artifact
         uses: actions/upload-artifact@v4
         with:
           name: App-${{ matrix.name }}-${{ matrix.arch }}
           path: |
-            ./App-*
-            ./*.dmg
+            ./release/*
 
   build_whl:
     runs-on: ubuntu-latest
@@ -110,7 +123,7 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
+          python-version: "3.11"
       - uses: yezz123/setup-uv@v4
 
       - name: Setup, install dependencies, build

.gitignore

@@ -1,5 +1,6 @@
 /.idea
 /build
+/release
 /App.lock
 /updater.json
 

.gitlab-ci.yml

@@ -4,6 +4,9 @@ stages:
   - build
   - release
 
+variables:
+  APP_NAME: "App"
+
 check_version:
   stage: validate
   image: reg.mikumikumi.xyz/mirror/bash:latest
@@ -27,13 +30,12 @@ check_version:
     REPORT_FILE: report-unit.xml
   rules:
     - changes:
-      - app/**
-      - tool/**
+        - app/**
   script:
-   - pip install uv
-   - uv sync
-   - uv run pyside-cli build --stage rc
-   - uv run pyside-cli test -- -v --junitxml=${REPORT_FILE}
+    - pip install uv
+    - uv sync
+    - uv run pyside-cli build --stage rc
+    - uv run pyside-cli test -- -v --junitxml=${REPORT_FILE}
   artifacts:
     reports:
       junit: report-*.xml
@@ -44,13 +46,12 @@ check_version:
     - pip install uv
     - uv sync
     - uv run pyside-cli build --onedir
-    - mv ./build/App ./Package
   rules:
     - if: $CI_COMMIT_TAG
   artifacts:
     name: "build-${CI_COMMIT_SHA}"
     paths:
-      - ./release/App-*
+      - ./release/*
     expire_in: 3 days
 
 test_windows_x64:
@@ -74,23 +75,26 @@ build_whl:
     - uv sync
     - uv run pyside-cli build --stage rc
     - uv build --no-sources
-    - mkdir release
+    - mkdir -p release
     - mv dist/*.whl release
   rules:
     - if: $CI_COMMIT_TAG
   artifacts:
     name: "build-${CI_COMMIT_SHA}"
     paths:
-      - ./release/*.whl
+      - ./release/*
     expire_in: 3 days
 
 build_windows_x64:
   extends: .build
   tags:
     - windows
   after_script:
+    - Move-Item -Path ./build/${APP_NAME} -Destination ./build/${APP_NAME}-windows-x64
     - New-Item -Path release -Type Directory
-    - Compress-Archive -Path .\Package\ -DestinationPath .\release\App-windows-x64.zip -CompressionLevel Optimal
+    - Compress-Archive -Path ./build/${APP_NAME}-windows-x64/ `
+      -DestinationPath ./release/${APP_NAME}-windows-x64-${CI_COMMIT_TAG}.zip `
+      -CompressionLevel Optimal
 
 build_linux_x64:
   extends: .build
@@ -99,8 +103,31 @@ build_linux_x64:
     - apt-get update
     - apt-get install -y patchelf
   after_script:
-    - mkdir release
-    - tar -czf ./release/App-linux-x64.tar.gz Package/
+    - mv ./build/${APP_NAME} ./build/${APP_NAME}-linux-x64
+    - mkdir -p release
+    - cd build
+    - tar -czf ../release/${APP_NAME}-linux-x64-${CI_COMMIT_TAG}.tar.gz \
+      ${APP_NAME}-linux-x64/
+
+# build_macos_arm64:
+#   stage: build
+#   tags:
+#     - macos
+#   script:
+#     - pip install uv
+#     - uv sync
+#     - uv run pyside-cli build
+#     - xattr -cr build/${APP_NAME}.app
+#     - brew install create-dmg
+#     - ./build-dmg.sh
+#     - mkdir -p release
+#     - cd build
+#     - zip -r "../release/${APP_NAME}-macos-arm64-${CI_COMMIT_TAG}.zip" "./${APP_NAME}.app"
+#   artifacts:
+#     name: "build-${CI_COMMIT_SHA}"
+#     paths:
+#       - ./release/*
+#     expire_in: 3 days
 
 # bug: glab issues in private repositories
 # https://gitlab.com/gitlab-org/cli/-/issues/7859
@@ -115,11 +142,12 @@ release:
       artifacts: true
     - job: build_linux_x64
       artifacts: true
+    # - job: build_macos_arm64
+    #   artifacts: true
   rules:
     - if: $CI_COMMIT_TAG
   script:
     - export GITLAB_HOST=$CI_SERVER_HOST
     - export GITLAB_TOKEN=$CI_JOB_TOKEN
     - glab auth login --job-token $CI_JOB_TOKEN --hostname $CI_SERVER_HOST --api-protocol $CI_SERVER_PROTOCOL
     - glab release create $CI_COMMIT_TAG --ref $CI_COMMIT_TAG -n "Release ${CI_COMMIT_TAG}" -F CHANGE.md ./release/*
-

app/__main__.py

@@ -1,15 +1,14 @@
 import asyncio
-import os.path
 import sys
+import os
 
-from PySide6.QtCore import QTranslator, QLockFile, QCoreApplication
+from PySide6.QtCore import QTranslator, QLockFile
 from qasync import QApplication, run
 
-from app.builtin.gitlab_updater import GitlabUpdater
 from app.builtin.locale import detect_system_ui_language
-from app.builtin.misc import running_in_bundle
+from app.builtin.utils import get_updater, init_app, running_in_bundle
+from app.builtin.paths import AppPaths
 from app.main_window import MainWindow
-from qdarktheme import enable_hi_dpi
 
 
 async def task():
@@ -25,29 +24,23 @@ async def task():
 
 
 def main(enable_updater: bool = True):
+    # init QApplication
+    app = init_app()
+    paths = AppPaths()
+
     # init updater, updater will remove some arguments
     # and do update logic
-    # updater = GithubUpdater()
-    # updater.project_name = "SHIINASAMA/pyside_template"
-    updater = GitlabUpdater()
-    updater.base_url = "https://gitlab.mikumikumi.xyz"
-    updater.project_name = "kaoru/pyside_template"
+    updater = get_updater()
     # self-updating is not available on macOS
     updater.is_enable = False if running_in_bundle else enable_updater
 
     # override updater config
-    if os.path.exists("updater.json"):
-        updater.load_from_file_and_override("updater.json")
-
-    # enable hdpi
-    enable_hi_dpi()
-
-    # init QApplication
-    app = QApplication(sys.argv)
+    config_file = paths.update_dir / "updater.json"
+    if os.getenv("DEBUG", "0") == "1" and config_file.exists() and config_file.is_file():
+        updater.load_from_file_and_override(config_file)
 
     # check if the app is already running
-    lock_dir = QCoreApplication.applicationDirPath()
-    lock_file = QLockFile(lock_dir + "/App.lock")
+    lock_file = QLockFile(str(paths.base_dir) + "/App.lock")
     if not lock_file.lock():
         sys.exit(0)
 

app/builtin/args.py

@@ -0,0 +1,28 @@
+import sys
+
+
+def pop_arg_pair(name) -> str:
+    argv = sys.argv
+
+    try:
+        idx = argv.index(name)
+    except ValueError:
+        raise RuntimeError(f"Missing required argument: {name}")
+
+    if idx + 1 >= len(argv):
+        raise RuntimeError(f"Argument {name} requires a value")
+
+    value = argv[idx + 1]
+
+    del argv[idx + 1]
+    del argv[idx]
+
+    return value
+
+
+def pop_arg(name, default_value):
+    if name in sys.argv:
+        sys.argv.remove(name)
+        return True
+    else:
+        return default_value

app/builtin/config.py

@@ -0,0 +1,12 @@
+from typing import Literal
+
+APP_NAME = "App"
+APP_DISPLAY_NAME = "App"
+ORG_NAME = "PySide Template"
+
+RemoteType = Literal["GitHub", "GitLab"]
+
+UPDATER_REMOTE_TYPE: RemoteType = "GitHub"
+UPDATER_URL = "https://api.github.com"
+UPDATER_PROJECT_NAME = "SHIINASAMA/pyside_template"
+UPDATER_APP_NAME = APP_NAME

app/builtin/github_updater.py

@@ -1,18 +1,18 @@
-import platform
-
 from glom import glom
 from httpx import AsyncClient
 
 from singleton_decorator import singleton
 
 
-from .update import Updater, Version
+from app.builtin.update import Updater, Version, get_arch, get_sysname
+from app.builtin.paths import AppPaths
 
 
 @singleton
 class GithubUpdater(Updater):
     base_url: str = "https://api.github.com"
     project_name: str = ""
+    app_name: str = "App"
     timeout = 5
     token = None
 
@@ -33,6 +33,7 @@ async def fetch(self):
             r = await client.get(
                 url=f"{self.base_url}/repos/{self.project_name}/releases",
                 params={"pre_page": "100", "page": "1"},
+                follow_redirects=True
             )
             r.raise_for_status()
             releases = []
@@ -50,28 +51,14 @@ async def fetch(self):
             self.remote_version = Version(latest_release["tag_name"])
             self.description = latest_release["body"]
 
-            arch = platform.machine().lower()
-            if arch in ["x86_64", "amd64"]:
-                arch = "x64"
-            elif arch in ["aarch64", "arm64"]:
-                arch = "arm64"
-            else:
-                raise RuntimeError(f"Unknown architecture: {arch}")
-
-            sysname = platform.system().lower()
-            if sysname == "windows":
-                sysname = "windows"
-            elif sysname == "darwin":
-                sysname = "macos"
-            elif sysname == "linux":
-                sysname = "linux"
-            else:
-                raise RuntimeError(f"Unknown system: {sysname}")
-            package_name = f"App-{sysname}-{arch}.zip"
+            arch = get_arch()
+            sysname = get_sysname()
+            package_name = f"{self.app_name}-{sysname}-{arch}"
 
             self.download_url = None
             for assets in glom(latest_release, "assets", default={}):
-                if assets["name"] == package_name:
+                if package_name in assets["name"]:
+                    package_name = assets["name"]
                     self.download_url = assets["browser_download_url"]
                     break
 
@@ -83,4 +70,5 @@ async def fetch(self):
             r = await client.head(url=self.download_url, follow_redirects=True)
             r.raise_for_status()
 
-            self.filename = package_name
+            paths = AppPaths()
+            self.filename = f"{paths.update_dir}/{package_name}"