Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 3.17 KB

File metadata and controls

74 lines (50 loc) · 3.17 KB

MiniDBA 发版说明(GitHub Actions)

本文描述在 GitHub Releases 上自动构建、打包多平台制品的流程,并与 DESIGN.md §4 一致:复制压缩包 → 解压 → 配置 config.yaml → 启动即可。静态资源由 go:embed 打进二进制,发布包内 不需要 单独的 web/ 目录。


1. 发版目标与制品形态

目标 说明
多平台 linux/amd64linux/arm64windows/amd64windows/arm64darwin/amd64darwin/arm64(由 .github/workflows/release.yml 定义)。
归档格式 Unix 系为 mini-dba-<tag>-<os>-<arch>.tar.gz,Windows 为 .zip(内含 mini-dba.exe)。
包内文件 mini-dbamini-dba.execonfig.example.yamlREADME.mdLICENSE
校验 同目录提供 mini-dba_<tag>_checksums.txtsha256sum)。

真实的 config.yaml 不进仓库、不打进包;由用户从示例复制后填写。


2. GitHub 侧(一次性)

  • 仓库在 GitHub,默认分支可跑 Actions。
  • 工作流 release.ymlpush tags 匹配 v* 时,在 ubuntu-latest 上交叉编译、打包、softprops/action-gh-release 上传;需 contents: write(已设)。
  • 离线资源门禁:go run ./scripts/check_offline_urls.go(与 CI 一致)。

首次可打测试 tag(如 v0.0.0-test1)验证 Release 资产后按团队规范清理。


3. 维护者日常操作

  1. 确认主分支与检查通过(含 CI)。
  2. 打 tag 并推送(任选):
    git tag -a v0.1.0 -m "Release v0.1.0"
    git push origin v0.1.0
    或使用 Task:task release:tag VERSION=v0.1.0(需已配置 origin)。
  3. 在 Actions 中查看 Release workflow;在 Releases 页核对各平台归档与 checksum。
  4. 抽检解压:应含 mini-dba / mini-dba.execonfig.example.yaml

4. 本地:Task(Windows / Linux)

任务 说明
task build 本机构建 Linux amd64./release/mini-dba(与日常开发/前置机构建习惯一致)。
task release:verify-offline 与 CI 相同的公网字体 CDN 检查。
task release:tag VERSION=v0.1.0 打附注 tag 并 git push origin(触发远程发版)。

多平台包 仅在推送 tag 后由 CI 生成,无需在本地安装额外发版工具。


5. 终端用户:解压与配置

DESIGN.md §4.1 一致:

  1. 下载对应平台归档并解压。
  2. 复制 config.example.yamlconfig.yaml,设置 secret_keydatabases 等。
  3. 启动:
    • Linux / macOS:./mini-dba -config ./config.yaml
    • Windows:mini-dba.exe -config config.yaml
  4. 浏览器访问监听地址,在 /login 使用 secret_key 登录。

部署检查清单见 DESIGN.md §10


6. 文档索引