Skip to content

Commit e96ed6a

Browse files
George Huclaude
authored andcommitted
docs: drop the "Auto-update setup (maintainers)" section from READMEs
Maintainer-only setup steps don't belong on the public README — they're runbook material, not user-facing docs. The README is now solely about what the app is and how to use it. Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>
1 parent 35f90e9 commit e96ed6a

2 files changed

Lines changed: 0 additions & 148 deletions

File tree

README.md

Lines changed: 0 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -224,80 +224,6 @@ npm run test:coverage # write HTML report to coverage/
224224

225225
---
226226

227-
## Auto-update setup (maintainers)
228-
229-
EchoWise ships with an in-app updater powered by `tauri-plugin-updater`. The desktop app polls a JSON manifest at app launch and from the Settings → About panel; when a signed bundle is newer than the installed version, the user can install it with one click.
230-
231-
Out of the box the update check is wired up but **signing is unconfigured** — the app will run fine without it, but auto-update will be disabled until you set it up. To enable:
232-
233-
### 1. Generate a signing keypair (one time)
234-
235-
```bash
236-
npx @tauri-apps/cli signer generate -w ~/.tauri/echowise-updater.key
237-
```
238-
239-
Two files are written:
240-
- `~/.tauri/echowise-updater.key`**private** key. Store it somewhere safe (password manager, secrets vault). Never commit it.
241-
- `~/.tauri/echowise-updater.key.pub` — public key. Print and copy it.
242-
243-
### 2. Embed the public key in `tauri.conf.json`
244-
245-
```json
246-
"plugins": {
247-
"updater": {
248-
"active": true,
249-
"pubkey": "<paste the content of echowise-updater.key.pub here>",
250-
"endpoints": [
251-
"https://github.com/hujiulin/EchoWise/releases/latest/download/latest.json"
252-
]
253-
}
254-
}
255-
```
256-
257-
Commit this change.
258-
259-
### 3. Add GitHub repo secrets
260-
261-
In GitHub → repository → **Settings → Secrets and variables → Actions**, add:
262-
263-
| Secret | Value |
264-
|---|---|
265-
| `TAURI_SIGNING_PRIVATE_KEY` | Contents of `~/.tauri/echowise-updater.key` |
266-
| `TAURI_SIGNING_PRIVATE_KEY_PASSWORD` | The password you set in step 1 (or empty if none) |
267-
268-
### 4. Ship a release
269-
270-
Push a `v*` tag as usual. The release workflow will:
271-
- Build per-platform installers
272-
- Sign each updater bundle with your private key
273-
- Upload a `latest.json` manifest alongside the installers
274-
275-
Existing users will see the update inside the app on next launch (after a quiet background check) and in **Settings → About → Updates**.
276-
277-
### Endpoint format
278-
279-
The `latest.json` file follows the [Tauri v2 schema](https://v2.tauri.app/plugin/updater/):
280-
281-
```json
282-
{
283-
"version": "0.2.0",
284-
"notes": "What's new",
285-
"pub_date": "2026-06-07T10:00:00Z",
286-
"platforms": {
287-
"darwin-aarch64": {
288-
"signature": "<base64>",
289-
"url": "https://github.com/.../EchoWise_0.2.0_aarch64.app.tar.gz"
290-
},
291-
"darwin-x86_64": { ... },
292-
"windows-x86_64": { ... }
293-
}
294-
}
295-
```
296-
297-
The release workflow generates this automatically when `TAURI_SIGNING_PRIVATE_KEY` is set.
298-
299-
---
300-
301227
## License
302228

303229
[MIT](LICENSE) © EchoWise contributors

README.zh.md

Lines changed: 0 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -224,80 +224,6 @@ npm run test:coverage # 出 HTML 覆盖报告到 coverage/
224224

225225
---
226226

227-
## 自动更新设置(维护者)
228-
229-
EchoWise 内置基于 `tauri-plugin-updater` 的自动更新。桌面端启动时和 Settings → About 面板都会去拉一个 JSON manifest;当签名过的新版可用时,用户一键即可安装。
230-
231-
更新检查的代码已经全部就绪,**但签名默认未配置** —— 不配置不影响应用使用,只是自动更新不会启用。开启步骤:
232-
233-
### 1. 生成签名密钥对(一次性)
234-
235-
```bash
236-
npx @tauri-apps/cli signer generate -w ~/.tauri/echowise-updater.key
237-
```
238-
239-
会生成两个文件:
240-
- `~/.tauri/echowise-updater.key` —— **私钥**。妥善保管(密码管理器 / 密钥库),**绝不提交**
241-
- `~/.tauri/echowise-updater.key.pub` —— 公钥。打开复制内容。
242-
243-
### 2. 把公钥写进 `tauri.conf.json`
244-
245-
```json
246-
"plugins": {
247-
"updater": {
248-
"active": true,
249-
"pubkey": "<把 echowise-updater.key.pub 的内容贴在这>",
250-
"endpoints": [
251-
"https://github.com/hujiulin/EchoWise/releases/latest/download/latest.json"
252-
]
253-
}
254-
}
255-
```
256-
257-
提交这个改动。
258-
259-
### 3. 加 GitHub 仓库 secrets
260-
261-
到 GitHub → 仓库 → **Settings → Secrets and variables → Actions**,添加:
262-
263-
| Secret ||
264-
|---|---|
265-
| `TAURI_SIGNING_PRIVATE_KEY` | `~/.tauri/echowise-updater.key` 文件的内容 |
266-
| `TAURI_SIGNING_PRIVATE_KEY_PASSWORD` | 第 1 步设置的密码(没设就留空) |
267-
268-
### 4. 发版
269-
270-
像往常一样 push `v*` tag,release workflow 会:
271-
- 在三个平台打包安装器
272-
- 用你的私钥签名每个更新包
273-
- 在 Releases 一起上传 `latest.json` manifest
274-
275-
现有用户下次启动 EchoWise 后,应用会在后台静默检查,并在 **Settings → About → Updates** 显示更新。
276-
277-
### Endpoint 格式
278-
279-
`latest.json` 遵循 [Tauri v2 schema](https://v2.tauri.app/plugin/updater/)
280-
281-
```json
282-
{
283-
"version": "0.2.0",
284-
"notes": "What's new",
285-
"pub_date": "2026-06-07T10:00:00Z",
286-
"platforms": {
287-
"darwin-aarch64": {
288-
"signature": "<base64>",
289-
"url": "https://github.com/.../EchoWise_0.2.0_aarch64.app.tar.gz"
290-
},
291-
"darwin-x86_64": { ... },
292-
"windows-x86_64": { ... }
293-
}
294-
}
295-
```
296-
297-
`TAURI_SIGNING_PRIVATE_KEY` 配置后,release workflow 会自动生成这个文件。
298-
299-
---
300-
301227
## License
302228

303229
[MIT](LICENSE) © EchoWise contributors

0 commit comments

Comments
 (0)