You've already forked CC-Framework.BriskGameServer
Add package sync workflow
This commit is contained in:
52
Brisk Package 发布流程.md
Normal file
52
Brisk Package 发布流程.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# Brisk Package 发布流程
|
||||
|
||||
本文档用于约定当前仓库的发布方式。
|
||||
|
||||
## 开发态
|
||||
|
||||
当前仓库是 Unity 原始开发工程:
|
||||
|
||||
- SDK 活代码放在 `Assets/BriskSdk/Runtime`
|
||||
- 示例脚本放在 `Assets/BriskSdk/Samples/QuickStart`
|
||||
- 示例场景放在 `Assets/Scenes/BriskQuickStartScene.unity`
|
||||
|
||||
## 发布态
|
||||
|
||||
对外发布 Git Package 时,不直接把整个 Unity 工程作为包发布。
|
||||
|
||||
统一从以下目录产出 package 内容:
|
||||
|
||||
- `PackageSource/com.foldcc.cc-framework.BriskGameServer`
|
||||
|
||||
该目录用于承载:
|
||||
|
||||
- `package.json`
|
||||
- `README.md`
|
||||
- `CHANGELOG.md`
|
||||
- `Documentation~`
|
||||
- `Runtime`
|
||||
- `Samples~`
|
||||
|
||||
## 同步步骤
|
||||
|
||||
在准备发布分支或发布 tag 前,执行:
|
||||
|
||||
```powershell
|
||||
./Tools/Sync-BriskPackage.ps1
|
||||
```
|
||||
|
||||
脚本会自动:
|
||||
|
||||
1. 从 `Assets/BriskSdk/Runtime` 同步到 `PackageSource/com.foldcc.cc-framework.BriskGameServer/Runtime`
|
||||
2. 从 `Assets/BriskSdk/Samples/QuickStart` 同步到 `PackageSource/com.foldcc.cc-framework.BriskGameServer/Samples~/QuickStart`
|
||||
3. 把 `Assets/Scenes/BriskQuickStartScene.unity` 一并复制到 package sample 目录
|
||||
|
||||
## 建议发布流程
|
||||
|
||||
1. 在开发分支完成功能
|
||||
2. 运行 `./Tools/Sync-BriskPackage.ps1`
|
||||
3. 检查 `PackageSource/com.foldcc.cc-framework.BriskGameServer` 内容
|
||||
4. 切到对外发布分支,或基于当前提交创建发布分支
|
||||
5. 只保留 package 所需目录,或以该子目录作为 git package 子路径
|
||||
6. 更新 `package.json` 版本号与 `CHANGELOG.md`
|
||||
7. 打 tag 给外部项目接入
|
||||
Reference in New Issue
Block a user