目录
PlasticSCM Unity项目版本控制系统(中文操作指南)
PlasticSCM(Unity项目版本控制系统)是一套无缝整合的Unity开发工作流,让您直接在Unity Hub对托管项目进行高效管理,从Unity编辑器使用版本控制系统(VCS)功能,轻松与团队协作!
在本操作指南中,您将轻松了解到以下内容:
- 如何轻松启用Plastic SCM协助您与团队的工作。
- 如何为PlasticSCM进行基本设置。
- 了解Plastic SCM的基本概念。
- 分步骤介绍使用PlasticSCM的基本流程。
- 如何创建新的仓库并提交第一个Commit(Checkin)。
- 如何Clone 克隆远程仓库项目到本地。
- 如何 Push/ Pull。将代码、资源或任何修改进行远程仓库与本地的同步。
- 如何回退到历史版本。
- 以及如何迁入其他现有项目。
相信您已经准备好启用PlasticSCM了,现在就让我们开始使用中国Unity提供的一体化项目托管解决方案 以及 50GB 免费空间吧!
了解更多PlasticSCM概况:
https://unity.cn/plasticscm
社区支持:
PlasticSCM论坛、中国Unity开发者社区
以下为本文档开源地址,欢迎社区伙伴反馈意见:
https://github.com/unity-cn/plasticscm-cn-guide
更详尽的PlasticSCM文档手册,请参考以下链接:
https://www.plasticscm.com/documentation
一、PlasticSCM的基础概念
这部分的目的是帮助您了解Plastic SCM中的概念的术语。 由于这些术语将在后续内容中提及,因此理解它们的含义也很有必要。
以下是您需要了解的一些概念:
- Organization 组织
相当于同一个公司或项目小组,作为团队进行协作,共享项目的组织单元。可通过https://id.unity.cn/organizations进行设置
用户可以自行创建组织并邀请其他成员加入进行项目协作,也可以被加入到他人所创建的组织中。
组织的普通用户身份(User)只有克隆项目的权限,而组织的所有者(Owner)或管理员(Manager)则拥有新建PlasticSCM项目的权限
- Repository 远程仓库
云存储空间。 远程仓库内通常将只会保持只有一个项目
- Workspace 本地工作区
存储到本地进行工作的资源所在目录
- Items 项目
工作区的内容-文件和目录
- Branch 分支
指仓库中当前正在使用的位置(⚠️请注意!目前流程默认在Main之外自动为每个用户创建各自的一个新分支!)
您可以点开PlasticSCM客户端对其他人的分支内容进行比较、复制、创建新分支、切换到不同位置、以及合并到Main等等操作
- Checkin 签入
您所完成并提交的修改
- Changeset 变更集
您所创建的签入
二、新建Plastic SCM项目
新建Plastic SCM项目
-
登录Unity Hub
登录Unity Hub您将看到PlasticSCM已经整合到您的项目管理列表中。
-
启用Plastic SCM
在新建项目的时候勾选启用PlasticSCM;
-
配置 PlasticSCM
Plastic SCM配置过程同样非常容易:
3.1、启用Plastic SCM时,Unity Hub将自动为您显示您自己创建过的Unity组织(Organization)以及您加入的其他Unity组织,它们将作为您的项目仓库所在的空间。
3.2、Unity Hub将请您选择您所在的任意一个Unity 组织(包括自己创建的,以及作为成员加入的)作为您的PlasticSCM默认组织。
3.3、选定PlasticSCM默认组织,并对项目点击确认后,Unity Hub将自动将您的项目同步到您的PlasticSCM空间。 -
完成新建项目
4.1,点击创建
系统将自动启动Unity引擎打开项目,自动创建远程仓库,并自动完成第一次的Checkin(Commit)。
您将看到远程仓库以及分支已经自动在项目中完成创建。
同时您也将看到PlasticSCM窗口已经自动将项目资源作为Pending changes Items(待提交内容)
4.2,自动创建一个新的Branch
这里需要注意Main分支与Branch分支的区别!创建PlasticSCM项目的同时,我们将为您的项目创建远程仓库,并在Main主线分支之外,自动创建一个新的Branch分支,作为您正在工作的分支,其目的是为了避免Main主线被作为直接修改和工作的位置。
关于如何将自己Branch(分支)中完成的修改Merge(合并)到Main(主线)中,请参考如何Merge?章节
4.3,完成创建(Hub视图)
您同时可以在Unity Hub的项目列表中看到刚才新建的项目,已经标识为已创建于远程仓库
三、托管现有项目到PlasticSCM
除了新建PlasticSCM项目,对于已有的项目,您可以在Hub中对它们一键托管,实现PlasticSCM的版本控制等协作管理功能。
1.登录Unity Hub
您可以从项目列表中看到,所有项目右侧的更多操作里包含了“托管到PlasticSCM”选项。
2,为现有项目选择启用PlasticSCM
3,为现有项目选择托管到某个组织中
4,完成现有项目托管
4.1 自动创建一个新的Branch
这里需要注意Main分支与Branch分支的区别!托管现有项目到PlasticSCM与新建PlasticSCM项目相同,我们将在您项目的远程仓库Main主线分支之外,自动创建一个新的Branch分支,作为您的工作分支,其目的是为了避免Main主线被作为直接修改和工作的位置。
关于如何将自己Branch(分支)中完成的修改Merge(合并)到Main(主线)中,请参考如何Merge?章节
4.2 其次还需要注意项目是否已经被推到仓库中!
选择托管但尚未点击打开过的项目,由于并没有完成第一次Checkin,因此组织内团队成员这时候暂时还看不到您托管的项目。
选择托管的项目只有当项目被打开之后(启动Unity引擎打开项目),系统才会自动完成第一次的Checkin(Commit)。
您将看到远程仓库以及分支已经自动在项目中完成创建。
4.3 完成托管(Hub视图)
您同时可以在Unity Hub的项目列表中看到刚才托管的项目,已经标识为已托管于远程仓库
四、如何Clone (克隆远程仓库项目到本地Workspace)?
当需要参与组织创建的新项目,我们首先需要把项目克隆到本地工作区才能开始工作。
1,在Hub中选择克隆项目
首先打开Unity Hub项目列表,选择PlasticSCM 标签,查看远程仓库中的项目
2,进行克隆
点击云按钮,从远程仓库的项目Branch分支,克隆项目到本地工作区(Workspace)路径
3,查看已克隆项目
这时候你会发现该项目已经被克隆到项目列表中
注意事项
- 目标项目的克隆位置来自您在远程仓库中的Branch分支
- 只有当您尚未创建Branch的时候,系统会从Main创建Branch并克隆到本地
- 克隆一般只用于首次参与项目时创建本地工作区(Workspace)用
- 如果需要同步该项目中包括其他成员修改的最新进度,则不应该进行克隆,因为这样会在此重复克隆项目中自己已有的Branch分支。正确的做法是在Editor中点开PlasticSCM客户端,将Main分支Pull(拉取)到自己的Branch分支上(详细请参考 “如何Pull” 步骤)
- 对Main分支进行合并操作的权限可以打开PlasticSCM客户端进行配置
五、如何Push(提交一个Checkin到我的Branch)?
1,提交一个Checkin(Commit)
当项目准备提交的时候,保存所做的修改,它们会出现在Checkin item窗口中,在Pending changes 窗口添加一个描述,勾选提交的Items,点击Checkin changes 完成第一次的Checkin
2,Auto Save(自动 Checkin)
与此同时,我们也提供了自动Checkin的选项,如果勾选之后,每5分钟将自动保存一次
3,查看您的提交
提交后您将可以在Changesets中可以看到您的提交历史
六、如何Pull(拉取团队成员的修改)?
当团队成员完成修改时,您可以通过Pull(拉取)已合并到Main分支上的所有修改(这个步骤我们称为 Pull From Main)
1,选择Main主线分支
2,选择要把Main合并我的Branch
在Main主线分支上点击右键,选择“Merge from this changeset…”
3,Checkin
输入Comment,点击Checkin
4,Update
回到Editor中可以看到有可更新的修改
5,查看并对比所修改的内容
通过可视化界面轻松查看对比
6,确认并更新
点击Update到您的Workspace(工作区)
七、如何进行分支(Branch)版本管理与合并(Merge)?
分支合并与版本管理正是Unity PlasticSCM独一无二的优势所在,结合可视化界面将让您得心应手。
- 合并(Merge)分支
1,确认本地修改工作
当我们在分支上做了其他更多的工作后,我们希望把这些新的工作成果合并回主线中
2,选择要合并到Main的Branch
这个时候我们在Branch分支上点击右键,选择“Merge from this changeset to…”
3,选择合并位置
这时候选择合并回主线的节点
4,检查提交合并内容
对比并确认正常的文件的差异,点击Apply Changes
5,Checkin
输入Comment,点击Checkin
6,完成从Branch分支到Main主线的合并
- 分支管理
1、点开PlasticSCM分支视图
2、确认提交的修改
3、点击右键,从本次的修改创建一个分支
4、查看分支
这个时候可以看到我们的Workspace位于分支上了,意味着我们接下来回到Unity中所做的工作将存放在我们常见的分支上
八、迁入其他现有项目
Git / Perforce / Visual Source Safe / Clearcase / TFS / Subversion
https://www.plasticscm.com/movetoplastic