-
Notifications
You must be signed in to change notification settings - Fork 129
feat: Sparkle 2 auto-update + 检查更新菜单 #3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
c9534b0
feat: integrate Sparkle 2 for auto-update
49e730c
fix(sparkle): add @executable_path/../Frameworks rpath to OpenLessApp
46a8736
Merge branch 'main' into feature/sparkle-auto-update
8c6405d
Merge branch 'main' into feature/sparkle-auto-update
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| import AppKit | ||
| import Sparkle | ||
|
|
||
| /// Sparkle 更新通道：启动时自动检查、菜单「检查更新…」手动触发、新版本弹窗由 Sparkle 内置 UI 提供。 | ||
| /// 默认配置： | ||
| /// - SUFeedURL：appcast.xml 的 raw GitHub URL（写在 Info.plist） | ||
| /// - SUPublicEDKey：EdDSA 公钥（写在 Info.plist）；私钥只在发版机的 Keychain 里 | ||
| /// - 启动后台后约 30s 做首次检查；之后每小时一次（也可在 Info.plist 调整） | ||
| @MainActor | ||
| final class UpdaterController: NSObject { | ||
| let updater: SPUStandardUpdaterController | ||
|
|
||
| override init() { | ||
| self.updater = SPUStandardUpdaterController( | ||
| startingUpdater: true, | ||
| updaterDelegate: nil, | ||
| userDriverDelegate: nil | ||
| ) | ||
| super.init() | ||
| } | ||
|
|
||
| /// 菜单项 target = self，action = #selector(checkForUpdates(_:)) | ||
| @objc func checkForUpdates(_ sender: Any?) { | ||
| updater.checkForUpdates(sender) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| #!/usr/bin/env bash | ||
| # 发新版的一条龙脚本。 | ||
| # | ||
| # 用法： | ||
| # ./scripts/release.sh <version> [<build_number>] [<release_notes_file>] | ||
| # | ||
| # 例： | ||
| # ./scripts/release.sh 1.0.02 A1004 docs/release-notes/1.0.02.md | ||
| # ./scripts/release.sh 1.0.02 | ||
| # | ||
| # 流程： | ||
| # 1. 改 build-app.sh 里的 APP_VERSION / BUILD_NUMBER | ||
| # 2. 跑 build-app.sh 出 .app | ||
| # 3. ditto 打包成 OpenLess-<version>.zip | ||
| # 4. sign_update zip → 拿 EdDSA 签名 + 长度 | ||
| # 5. 在 appcast.xml 里追加新 <item> | ||
| # 6. git commit appcast.xml + build-app.sh | ||
| # 7. git tag v<version> + push main + push tag | ||
| # 8. gh release create + 上传 zip | ||
| # | ||
| # 依赖： | ||
| # - /tmp/sparkle-tools/bin/sign_update（首次会自动从 Sparkle release 下载） | ||
| # - gh CLI 已登录 | ||
| # - Keychain 里有 Sparkle EdDSA 私钥（已生成一次性） | ||
|
|
||
| set -euo pipefail | ||
| cd "$(dirname "$0")/.." | ||
|
|
||
| VERSION="${1:?用法: ./scripts/release.sh <version> [<build_number>] [<release_notes_file>]}" | ||
| BUILD="${2:-}" | ||
| NOTES_FILE="${3:-}" | ||
|
|
||
| if [ -z "${BUILD}" ]; then | ||
| # 默认把 build number 设为 version 的简单变形（去掉点）。用户可显式覆盖。 | ||
| BUILD="$(echo "${VERSION}" | tr -d '.')" | ||
| fi | ||
|
|
||
| APP_NAME="OpenLess" | ||
| APP_DIR="build/${APP_NAME}.app" | ||
| ZIP_NAME="${APP_NAME}-${VERSION}.zip" | ||
| ZIP_PATH="build/${ZIP_NAME}" | ||
| APPCAST="appcast.xml" | ||
| SPARKLE_TOOLS_DIR="/tmp/sparkle-tools" | ||
| SIGN_UPDATE="${SPARKLE_TOOLS_DIR}/bin/sign_update" | ||
| SPARKLE_VERSION="2.9.1" | ||
|
|
||
| # 1. 确保 sign_update 工具就位 | ||
| if [ ! -x "${SIGN_UPDATE}" ]; then | ||
| echo "[release] 下载 Sparkle ${SPARKLE_VERSION} 工具..." | ||
| mkdir -p "${SPARKLE_TOOLS_DIR}" | ||
| (cd "${SPARKLE_TOOLS_DIR}" && \ | ||
| gh release download "${SPARKLE_VERSION}" -R sparkle-project/Sparkle \ | ||
| -p "Sparkle-${SPARKLE_VERSION}.tar.xz" --skip-existing && \ | ||
| tar -xJf "Sparkle-${SPARKLE_VERSION}.tar.xz") | ||
| fi | ||
|
|
||
| # 2. 改 build-app.sh 里的版本 | ||
| echo "[release] 写入版本号 ${VERSION} / ${BUILD}" | ||
| /usr/bin/sed -i '' "s/^APP_VERSION=.*/APP_VERSION=\"${VERSION}\"/" scripts/build-app.sh | ||
| /usr/bin/sed -i '' "s/^BUILD_NUMBER=.*/BUILD_NUMBER=\"${BUILD}\"/" scripts/build-app.sh | ||
|
|
||
| # 3. 构建 .app（不重置 TCC，避免本机权限被清掉） | ||
| echo "[release] 构建 .app" | ||
| RESET_TCC=0 ./scripts/build-app.sh > /dev/null | ||
|
|
||
| # 4. 打包 zip | ||
| rm -f "${ZIP_PATH}" | ||
| ditto -c -k --keepParent "${APP_DIR}" "${ZIP_PATH}" | ||
| ZIP_SIZE=$(/usr/bin/stat -f%z "${ZIP_PATH}") | ||
| echo "[release] zip = ${ZIP_PATH} (${ZIP_SIZE} bytes)" | ||
|
|
||
| # 5. 用 Keychain 里的 EdDSA 私钥签 zip | ||
| SIGN_OUTPUT=$("${SIGN_UPDATE}" "${ZIP_PATH}") | ||
| # 输出形如：sparkle:edSignature="xxxx" length="1234567" | ||
| EDSIG=$(echo "${SIGN_OUTPUT}" | /usr/bin/sed -n 's/.*sparkle:edSignature="\([^"]*\)".*/\1/p') | ||
| [ -n "${EDSIG}" ] || { echo "签名失败，sign_update 输出：${SIGN_OUTPUT}"; exit 1; } | ||
| echo "[release] EdDSA 签名 OK" | ||
|
|
||
| # 6. 准备 release notes（HTML 片段） | ||
| if [ -n "${NOTES_FILE}" ] && [ -f "${NOTES_FILE}" ]; then | ||
| NOTES_HTML="<![CDATA[$(cat "${NOTES_FILE}")]]>" | ||
| else | ||
| NOTES_HTML="<![CDATA[<p>OpenLess ${VERSION}</p>]]>" | ||
| fi | ||
|
|
||
| PUB_DATE=$(/bin/date -u +"%a, %d %b %Y %H:%M:%S +0000") | ||
| DOWNLOAD_URL="https://github.com/appergb/openless/releases/download/v${VERSION}/${ZIP_NAME}" | ||
|
|
||
| # 7. 在 appcast.xml 的 <channel> 顶部插入新 <item> | ||
| NEW_ITEM=$(cat <<EOF | ||
| <item> | ||
| <title>OpenLess ${VERSION}</title> | ||
| <pubDate>${PUB_DATE}</pubDate> | ||
| <sparkle:version>${BUILD}</sparkle:version> | ||
| <sparkle:shortVersionString>${VERSION}</sparkle:shortVersionString> | ||
| <sparkle:minimumSystemVersion>15.0</sparkle:minimumSystemVersion> | ||
| <description>${NOTES_HTML}</description> | ||
| <enclosure | ||
| url="${DOWNLOAD_URL}" | ||
| length="${ZIP_SIZE}" | ||
| type="application/octet-stream" | ||
| sparkle:edSignature="${EDSIG}" /> | ||
| </item> | ||
| EOF | ||
| ) | ||
|
|
||
| # 用 awk 在 <description>OpenLess update feed</description> 之后插入新 item | ||
| TMP_APPCAST=$(/usr/bin/mktemp) | ||
| /usr/bin/awk -v new_item="${NEW_ITEM}" ' | ||
| /<description>OpenLess update feed<\/description>/ { | ||
| print "" | ||
| print new_item | ||
| next | ||
| } | ||
| { print } | ||
| ' "${APPCAST}" > "${TMP_APPCAST}" | ||
| mv "${TMP_APPCAST}" "${APPCAST}" | ||
| echo "[release] appcast.xml 已追加 ${VERSION}" | ||
|
|
||
| # 8. git commit + tag + push | ||
| git add scripts/build-app.sh "${APPCAST}" | ||
| git commit -m "release: v${VERSION} (build ${BUILD})" | ||
| git tag "v${VERSION}" | ||
| git push origin main | ||
| git push origin "v${VERSION}" | ||
|
|
||
| # 9. gh release create + 上传 zip | ||
| gh release create "v${VERSION}" "${ZIP_PATH}" \ | ||
| --title "OpenLess ${VERSION}" \ | ||
| --notes-file "${NOTES_FILE:-/dev/stdin}" <<EOF | ||
| OpenLess ${VERSION} (build ${BUILD}). | ||
|
|
||
| 老用户：app 启动后自动检查更新；首次安装见 README。 | ||
| EOF | ||
|
|
||
| echo | ||
| echo "[release] 完成 ✅" | ||
| echo " Tag: v${VERSION}" | ||
| echo " Release: https://github.com/appergb/openless/releases/tag/v${VERSION}" | ||
| echo " Zip: ${ZIP_PATH} (${ZIP_SIZE} bytes)" | ||
| echo " Sig: ${EDSIG}" | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue (bug_risk): Interpolating NEW_ITEM into awk -v breaks when the XML snippet contains double quotes and newlines.
Because NEW_ITEM includes XML with double quotes and newlines, expanding it in
-v new_item="${NEW_ITEM}"causes awk to see unescaped"..."and line breaks in the command line, leading to syntax errors or truncated content. Please avoid passing the raw XML via-v; for example, insert via a placeholder in appcast.xml replaced withsed/perl, or feed the<item>block from stdin (here-doc) and let awk or another tool insert it. The key is to keep the XML out of shell-quoted awk arguments.