Update publishing guides

This commit is contained in:
Him188 2020-11-25 18:13:52 +08:00
parent 335f8cb0ad
commit ac36a560fb

View File

@ -26,7 +26,35 @@ Mirai Console 项目由四个模块组成后端前端Gradle 插件In
### 构建
```shell script
gradlew build
./gradlew build
```
首次加载和构建 mirai-console 项目可能要花费数小时时间。
首次加载和构建 mirai-console 项目可能要花费数小时时间。
### 发布版本
(针对拥有 Mirai Console write 权限的项目成员)
若你要发布一个 Mirai Console dev release
1. 更新 buildSrc/Versions.kt 中 `project` 版本号为目标版本;
2. 本地执行 `./gradlew fillBuildConstants`
3. Push 第 12 步的修改为同一个 commitcommit 备注为版本号名称,如 `1.0.1-dev-1`
4. 添加 Git 版本号 tag格式为 `1.0.1-dev-1`(不带 `v`
5. `git push --tags` 推送 tag 更新GitHub Actions 将会检测到 tag 更新并执行 JCenter 发布。
若你要发布一个 Mirai Console 稳定版 release请按顺序进行如下检查
1. 在 GitHub [milestones](https://github.com/mamoe/mirai-console/milestones) 确认目标版本的工作已经处理完毕;
2. Close milestone
3. 更新 buildSrc/Versions.kt 中 `project` 版本号为目标版本;
4. 在 [ConfiguringProjects](ConfiguringProjects.md#选择版本) 更新稳定版本号;
5. 本地执行 `./gradlew fillBuildConstants`
6. Push 前几步的修改为同一个 commitcommit 备注为版本号名称,如 `1.1.0`
7. 在 GitHub release 根据 Git commit 记录编写更新记录:
- 描述所有来自社区的 PR 记录;
- 完整列举公开 API 的任何变动,简要描述或省略内部变动;
- 为更改按 “后端”“前端”“IDE 插件”“Gradle 插件” 分类;
8. 点击 `Publish`。GitHub Actions 将会检测到 tag 更新并执行 JCenter 发布。