ci(release): 重构发布流水线,新增中文发布说明脚本,更新文档

重构GitHub Actions发布流水线:
- 改为手动触发,支持beta测试和正式发布两种模式
- 自动基于UTC时刻生成BUILD ID作为版本后缀
- 拆分打包签名与发布步骤,新增中文发布说明生成逻辑
新增scripts/release-notes.ps1脚本,用于生成带提交记录的中文发布说明
更新docs/auto-update-plan.md文档,适配新的发布流程并新增对应章节
This commit is contained in:
2026-08-28 02:33:47 +08:00
parent 3653e26a09
commit 30451d505c
5 changed files with 179 additions and 35 deletions
+77 -32
View File
@@ -1,13 +1,19 @@
# Koring Launcher Windows 发布流水线:构建 → SignPath 签名 → 发布 GitHub Releases # Koring Launcher 构建 & 发布流水线(手动触发):构建 → SignPath 签名 → 发布 GitHub Release
# #
# 触发方式 # 手动触发(Actions 页面 -> Run workflow
# 1) 推送 tag v*(推荐):先本地升版(node scripts/version.js 1.2.1)并打 tag v1.2.1 # mode 选择构建模式:beta(测试)或 run(正式)
# 推送后本流水线构建、签名并把产物发布到该 tag 对应的 GitHub Release。 # version 基础版本号,如 1.2.0
# 2) 手动触发 workflow_dispatch:填版本号,构建产物发布到 v<版本号> Release。 # 自动生成 BUILD IDAction 运行的 UTC 时刻,格式 YYMMDDHHMM,如 2608280224),
# 最终版本号 = {version}-{BUILD ID}(如 1.2.0-2608280224),tag = v{version}-{BUILD ID}。
# #
# 需要的仓库 SecretsSettings -> Secrets and variables -> Actions # 发布行为
# SIGNPATH_API_TOKEN SignPath API Token(必填;放在 Environment "BUILDER" 的环境 Secrets 中, # - beta:创建 GitHub prerelease(不占用 "Latest" 位)
# 本 job 声明 environment: BUILDER 后才能读取) # - run :创建正式 release
# - Release 正文为中文:版本信息(当前版本 / 编译状态)+ 自上个 release tag 以来的提交记录(默认折叠)
# - 上传产物:koring-launcher-{version}-{BUILD ID}-setup.exe + latest.ymlelectron-updater 更新清单)
#
# Secrets
# SIGNPATH_API_TOKEN SignPath API Token(必填;放在 Environment "BUILDER" 的环境 Secrets 中)
# SIGNPATH_ARTIFACT_CONFIG_SLUG 产物配置 slug(项目只有一个配置时可留空;仓库级 Secret) # SIGNPATH_ARTIFACT_CONFIG_SLUG 产物配置 slug(项目只有一个配置时可留空;仓库级 Secret)
# #
# 组织 ID / slug 非密钥,直接写在下方 env(SignPath 后台确认值): # 组织 ID / slug 非密钥,直接写在下方 env(SignPath 后台确认值):
@@ -17,26 +23,29 @@
# #
# ⚠️ 签名策略说明: # ⚠️ 签名策略说明:
# - 审批流程:SignPath 后台已关闭人工审批(自动批准),CI 可全自动。 # - 审批流程:SignPath 后台已关闭人工审批(自动批准),CI 可全自动。
# - 证书:当前策略 Purpose 为 Release signing测试证书,用户机器默认不信任 # - 证书:当前策略测试证书,用户机器默认不信任SmartScreen / 杀软警告),
# SmartScreen / 杀软警告),正式对外发布需生产证书(OV/EV)+ 对应生产签名策略, # 正式对外发布需生产证书(OV/EV)+ 对应生产签名策略,届时只换 SIGNPATH_SIGNING_POLICY_SLUG。
# 届时只需更换下方 SIGNPATH_SIGNING_POLICY_SLUG。
# #
# 说明 # ⚠️ 版本号注意(electron-updater 语义)
# - electron-builder 的 win.sign 会调用 scripts/signpath-sign.js 逐个文件远程签名, # - {version}-{BUILD ID} 属于 semver prerelease;已安装同格式版本的用户可正常收到更高 BUILD ID 的更新。
# 签名后自动生成的 latest.yml / blockmap 哈希即对应签名后的安装包 # - 若未来发布不带 BUILD ID 的稳定版本(如 1.2.0),稳定版用户不会自动升级到带 BUILD ID 的构建
# - 发布使用 GITHUB_TOKEN(自动注入,需 contents: write 权限创建/更新 Release)。
name: Release Windows (SignPath) name: BUILD & Release (SignPath)
on: on:
push:
tags:
- 'v*'
workflow_dispatch: workflow_dispatch:
inputs: inputs:
version: mode:
description: 'Version to build and publish (e.g. 1.2.1)' description: '构建模式:beta(测试)/ run(正式)'
required: true required: true
type: choice
options:
- beta
- run
version:
description: '基础版本号,如 1.2.0'
required: true
default: '1.2.0'
permissions: permissions:
contents: write contents: write
@@ -54,6 +63,9 @@ jobs:
SIGNPATH_ARTIFACT_CONFIG_SLUG: ${{ secrets.SIGNPATH_ARTIFACT_CONFIG_SLUG }} SIGNPATH_ARTIFACT_CONFIG_SLUG: ${{ secrets.SIGNPATH_ARTIFACT_CONFIG_SLUG }}
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
with:
# 需要完整历史:生成中文提交记录(自上个 release tag 以来)
fetch-depth: 0
- uses: pnpm/action-setup@v4 - uses: pnpm/action-setup@v4
with: with:
@@ -67,19 +79,52 @@ jobs:
- name: Install dependencies - name: Install dependencies
run: pnpm install --frozen-lockfile run: pnpm install --frozen-lockfile
# 手动触发时按输入升版(tag 触发时版本已在 package.json # BUILD ID = Action 运行时刻(UTC, YYMMDDHHMM),如 2608280224
- name: Set version (manual runs only) - name: Generate BUILD ID & set version
if: github.event_name == 'workflow_dispatch' && inputs.version != '' id: version
run: node scripts/version.js ${{ inputs.version }} shell: pwsh
run: |
$buildId = [DateTime]::UtcNow.ToString('yyMMddHHmm')
$full = "${{ inputs.version }}-$buildId"
node scripts/version.js $full
"build_id=$buildId" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
"full=$full" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
Write-Host "BUILD ID: $buildId -> version: $full"
- name: Build renderer + main (production) - name: Build renderer + main (${{ inputs.mode }})
run: pnpm build:run shell: pwsh
run: |
- name: Switch production icons if ("${{ inputs.mode }}" -eq "beta") {
run: pnpm icon:run pnpm build:beta
pnpm icon:beta
} else {
pnpm build:run
pnpm icon:run
}
# 关键步骤:win.sign 自定义签名(SignPath)在打包过程中逐个签名内部 exe 与 setup.exe # 关键步骤:win.sign 自定义签名(SignPath)在打包过程中逐个签名内部 exe 与 setup.exe
- name: Package, sign and publish to GitHub Releases - name: Package & sign (SignPath)
run: pnpm exec electron-builder --win --publish always run: pnpm exec electron-builder --win --publish never
- name: Generate Chinese release notes
shell: pwsh
run: |
./scripts/release-notes.ps1 `
-BaseVersion "${{ inputs.version }}" `
-FullVersion "${{ steps.version.outputs.full }}" `
-Mode "${{ inputs.mode }}" `
-OutputPath release-notes.md
- name: Publish GitHub Release
shell: pwsh
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
$tag = "v${{ steps.version.outputs.full }}"
$prerelease = if ("${{ inputs.mode }}" -eq "beta") { "--prerelease" } else { "" }
gh release create $tag `
"dist-electron/koring-launcher-${{ steps.version.outputs.full }}-setup.exe" `
"dist-electron/latest.yml" `
--title "Koring Launcher Releases ${{ inputs.version }}" `
--notes-file release-notes.md `
$prerelease
+1
View File
@@ -32,3 +32,4 @@ electron-dist/
# Build resources (generated by switch-icon.js) # Build resources (generated by switch-icon.js)
build/ build/
dsh-usage/usage-records.json
+24 -1
View File
@@ -257,7 +257,8 @@ src/
**新增/改动文件** **新增/改动文件**
- `scripts/signpath-sign.js` — 签名模块(无 token 自动跳过,本地构建不受影响) - `scripts/signpath-sign.js` — 签名模块(无 token 自动跳过,本地构建不受影响)
- `.github/workflows/release.yml`推送 tag `v*`(或手动填版本)→ 构建 → 签名 → `electron-builder --publish always` 发布 GitHub Releases - `.github/workflows/release.yml`手动触发:选择 beta/run → 构建 → 签名 → 发布 GitHub Release(见 §13
- `scripts/release-notes.ps1` — 中文 Release 发布说明生成器
- `electron-builder.yml``win.sign` 挂载 - `electron-builder.yml``win.sign` 挂载
**CI Secrets**:仅 `SIGNPATH_API_TOKEN`(必填)+ `SIGNPATH_ARTIFACT_CONFIG_SLUG`(可选); **CI Secrets**:仅 `SIGNPATH_API_TOKEN`(必填)+ `SIGNPATH_ARTIFACT_CONFIG_SLUG`(可选);
@@ -275,3 +276,25 @@ src/
**验证点(首次 CI 运行)**:确认 SignPath 请求全部 Completed、`latest.yml` 的 sha512 **验证点(首次 CI 运行)**:确认 SignPath 请求全部 Completed、`latest.yml` 的 sha512
与上传的 signed setup.exe 一致、签名链显示 "Lingke Network"。 与上传的 signed setup.exe 一致、签名链显示 "Lingke Network"。
## 13. 发布流水线(手动触发 / BUILD ID / 中文 Release
**触发方式**Actions 页面 → Run workflow,仅手动触发(不再使用 tag 触发)。
- `mode``beta`(测试,发布为 GitHub prerelease/ `run`(正式,发布为普通 release
- `version`:基础版本号(如 `1.2.0`
**版本号与 BUILD ID**
- BUILD ID = Action 运行的 **UTC 时刻**,格式 `YYMMDDHHMM`(如 `2608280224`
- 最终版本 = `{version}-{BUILD ID}`(如 `1.2.0-2608280224`),tag = `v{version}-{BUILD ID}`
electron-builder 产物 = `koring-launcher-{version}-{BUILD ID}-setup.exe``latest.yml` 同步更新
**发布内容**`gh release create`,中文正文由 `scripts/release-notes.ps1` 生成):
- `# Koring Launcher Releases {version}` + 版本信息(当前版本 / 编译状态 BETA/RUN
- `## 更新了什么内容`:自上个 `v*` tag 以来的提交记录,每条默认折叠
`<details><summary>·Commit 1cf906d</summary>…</details>`
- 上传产物:setup.exe + latest.ymlelectron-updater 更新清单)
**⚠️ 版本语义注意(electron-updater**
- `{version}-{BUILD ID}` 属 semver prerelease:同格式版本之间可正常升级(BUILD ID 更大者胜)
- 若未来发布**不带** BUILD ID 的稳定版本(如 `1.2.0`),稳定版用户不会自动升级到带 BUILD ID 的构建
- 同一分钟内重复触发会产生相同 BUILD ID → tag 冲突,`gh release create` 会失败,稍候重试即可
File diff suppressed because one or more lines are too long
+75
View File
@@ -0,0 +1,75 @@
# Koring Launcher 中文 Release 发布说明生成器
#
# 用法(GitHub Actions 中调用):
# ./scripts/release-notes.ps1 -BaseVersion "1.2.0" -FullVersion "1.2.0-2608280224" -Mode "beta" -OutputPath release-notes.md
#
# 输出(MarkdownUTF-8):
# # Koring Launcher Releases {BaseVersion}
# ## 版本信息
# 当前版本 {FullVersion}
# 编译状态:BETA / RUN
# ## 更新了什么内容
# <details><summary>·Commit 1cf906d</summary>提交说明…</details>(默认折叠)
param(
[Parameter(Mandatory = $true)][string] $BaseVersion,
[Parameter(Mandatory = $true)][string] $FullVersion,
[Parameter(Mandatory = $true)][string] $Mode,
[string] $OutputPath = "release-notes.md"
)
$status = if ($Mode -eq 'beta') { 'BETA' } else { 'RUN' }
$rec = [char]0x1e # 记录分隔符(每个 commit 一条)
$sep = [char]0x1f # 字段分隔符(hash / subject / body
$format = "%x1f%H%x1f%s%x1f%b%x1e"
# 自上个 release tag(v*)以来的提交;无 tag 则取全部提交
$lastTag = git tag --sort=-version:refname 2>$null | Where-Object { $_ -match '^v' } | Select-Object -First 1
if ($lastTag) {
Write-Host "Commits since tag: $lastTag"
$raw = git log --format=$format "$lastTag..HEAD"
} else {
Write-Host "No release tags found, listing all commits"
$raw = git log --format=$format "HEAD"
}
$blocks = @()
foreach ($record in ($raw -split [regex]::Escape($rec))) {
if (-not $record) { continue }
$parts = $record -split [regex]::Escape($sep)
if ($parts.Length -lt 4) { continue }
$hash = $parts[1].Trim()
$subject = $parts[2].Trim()
$body = $parts[3].Trim()
if (-not $hash) { continue }
$short = $hash.Substring(0, [Math]::Min(7, $hash.Length))
$inner = $subject
if ($body) { $inner += "`n`n$body" }
$blocks += @"
<details>
<summary>·Commit $short</summary>
$inner
</details>
"@
}
$commitsSection = if ($blocks.Count -gt 0) { $blocks -join "`n`n" } else { '· 无提交记录' }
$content = @"
# Koring Launcher Releases $BaseVersion
##
$FullVersion
$status
##
$commitsSection
"@
[System.IO.File]::WriteAllText($OutputPath, $content, [System.Text.UTF8Encoding]::new($false))
Write-Host "Release notes written to $OutputPath ($($blocks.Count) commits)"