1.概述
使用TortoiseGit比直接使用git 客户端和命令实现代码版本管理更为方便,本文根据实际使用情况作一些记录,特别是对于解决冲突的处理。
2.Git安装与配置
下载 Git - Downloads, 可参考Git安装步骤完成Git的安装与配置。
3.TortoiseGit安装与配置
3.1 TortoiseGit介绍
TortoiseGit是TortoiseSVN的Git版本,是一个在Windows系统下使用的Git版本控制客户端。它提供了图形用户界面,操作简单,同时完全兼容Git的命令行操作。
TortoiseGit可以用于执行常规任务,如提交、查看日志、差异比较、创建分支和标签、创建补丁等。它还支持与远程仓库的交互,如推送(push)和拉取(pull)操作。
3.2 TortoiseGit下载与安装
在官网下载 Download – TortoiseGit – Windows Shell Interface to Git, 以及中文简体语言包
客户端与语言包的安装方法,一直下一步默认选择,具体做法此处省略。可参考TortoiseGit安装与配置(图文详细)与 Git客户端(TortoiseGit)基本使用详解
3.3 TortoiseGit配置
1. 首先,选定一个存放Git项目的目录,这样管理方便. 如: D:\work , 然后打开到指定目录。
2. 在空白处点击鼠标右键,可以看到右键菜单中多了几个选项。选择 --> TortoiseGit --> Settings,然后就可以看到配置界面。
3. 点击General进行简单配置。Language可以切换语言(可以中英文之间切换使用)。不要勾选自动升级的复选框。可能还需要指定 Git.exe 文件的安装路径, 如 "C:\Program Files\Git\bin"。完成后,点击应用,确定关闭对话框。如下所示:
4、配置右键菜单.。在设置对话框中,点选左边的"Context Menu",设置常用的右键菜单。本人比较常用的是如下选项:
5. 设置记住密码
!!!密码会明文保存在 C:\Users\Administrator\.git-credentials 这种文件中, 请小心使用.
进入设置, 点选左边的Git标签.可以发现,右边可以配置用户的名字与Email信息. 如下图所示:
若在某个本地Git项目下打开配置对话框,那么这个按钮就可用,然后可编辑此项目的一些属性。
点击 “Edit global .git/config(O)”按钮,会使用记事本打开全局配置文件,在全局配置文件中,在后面加上下面的内容:
[credential]
helper = store
完成后保存,关闭记事本,确定即可。
当你推送项目到GitHub等在线仓库或托管的仓库时,会记住你输入的用户名和密码。
4.TortoiseGit使用
4.1 使用示例
4.1.1 克隆项目(从仓库获取)
在工作目录下,如D:\work,空白处右键,选择: Git clone,则会弹出克隆对话框,如下图所示:
在URL中填写项目的访问地址,或者比如从GitHub:https://github.com/goodfeli/adversarial.git
根据项目大小,时间会不一样。克隆完成后,如果没有错误,会给出提示:
进入克隆下的文件夹中,如D:\work\opt,空白处右键,弹出如下菜单:
其中,Git Pull是从远端拉取最新的代码,Git Fetch是从远端拉取最新的分支,Git Push是将本地仓库的代码提交到远端
Git Commit ->”master”,将本地代码提交到本地版本库(默认的分支是master)。
4.1.2 本地代码提交到本地仓库
创建一个文件,如test.txt, 先add再提交到本地版本库(因为不涉及发送到远端,这个步骤可在离线状态操作)
填写提交备注message(不填写不允许提交),勾选需要提交的文件,点击commit,即可将本地代码提交到本地版本库。出现如下弹框,表示本地提交成功:
其中,提交时,会发现上图中的Status有几种值:
Unknown:新增的文件,也不在版本库
Added:新增的文件,在版本库
Modified:文件修改,在版本库
Missing:文件被删除,在版本库
注意:提交成功后,本地的test文件的提示符号“?”变为绿色的“√” 表示修改版本已提交到位。
提交前: 提交后:
4.1.3 查看log日志
右键选择Git Show Log(这个菜单可以通过上面的的配置出来)。在日志中,可以通过日期、文件名、提交人等等过滤查询。
通过日志,可以很直观的看到提交相关记录。比如提交人、提交时间、提交了哪些文件等等。这些信息便于以后进行文件对比或者版本对比,甚至版本回滚(后面将会介绍)。
点击test.txt,可以看到本次提交,对test文件进行了哪些操作(也就是添加了一行 Hello World):
4.1.4 代码提交到远程
将代码推送(push)到远程,这里演示的是本人的代码托管仓库。
右键空白处,选择Git Push,出现如下弹框:
这里可以看到是本地哪个版本库提交到远端哪个版本。至此,文件的整个提交过程就完成了。
PS:首先commit提交到本地仓库,然后pull拉取一下合并代码,确保push为最新的版本代码。
4.1.5 忽略提交设置
有时候我们一些文件是不需要提交的比如说 idea/eclipse,或者说本地记录的一些简要说明,不是正式提交的README.md这种文件,或者开发的代码自动生成的配置文件,如何设置为不提交呢?
按照提示方式,标记a.txt或全部 .txt 为可忽略文件,此时我们根目录下会生成一个.gitignore文件,
忽略文件如何阅读,常见格式如下:
# 所有以.a 结尾的文件讲被忽略(递归)
*.a
# 不管其他规则怎样,强制不忽略 lib.a
!lib.a
# 只忽略 文件 TODO (注意这里是文件)
/TODO
# 忽略 build文件夹下所有内容(递归) 这里是文件夹
build/
# 忽略 doc 目录下以 *.txt 结尾的文件 (不递归)
doc/*.txt
# 忽略 doc 目录下以 *.pdf 结尾的文件 (递归)
doc/**/*.pdf
4.2 分支管理
上述介绍的都是一些基本用法,使用小乌龟的优势主要是体现在版本控制与分支管理上。下面介绍分支与版本管理。
对于通常的项目开发,比如想新加一个功能进去的时候,可以先新建一个分支,例如名字叫dev-0430,然后在分支中把新功能加上去,如果OK,将代码合并到master分支上,如果新功能失败,还可以回退到master分支上来,在dev-0430写的代码,不至于影响master分支。
4.2.1 查看分支
查看分支,包括查看本地已拉取的分支和远端全部提交的有效分支。对应的就是命令
$ git branch -a #查看所有分支
$ git branch # 查看本地分支
$ git branch -r #查看远程分支
方法一:
右键-->TortoiseGit-->Switch/ Checkout 看到的是全部的分支,远端分支前有remotes字样。
方法二:
右键-->TortoiseGit-->Show log,
在打开的窗口中,比如选中左上角master(当前的本地分支),弹出的窗口中heads就是本地已拉取的分支,remotes显示的就是远程的所有分支。
4.2.2 新建与切换分支
1. 选中刚刚拉取的文件夹D:\zzwork\opt, 右键-->TortoiseGit-->Create Branch,如果是在已经建好的另外一个分支开发,则选中Switch/Checkout
2. 在开发目录下右键或选中文件夹D:\zzwork\opt,会发现当前的分支为你新建的dev-0430分支了
3. 接下来,可以新增具体的功能,比如我们在test.txt文件中再添加一行文字,新增一个文件test2.txt,添加一行文字,内容如下,其中test.txt的图标由“√变为了“ !”,表示修改后没有commit,而test2是新增加的,图标是黑色。
4. 提交我们的代码到dev-0430分支的本地仓库,具体可参考之前的4.1.2章节关于提交的部分,
提交完成后,图标都变为绿色,表示版本已经commit到位。
5. 如果突然发现该功能有bug,想回到之前的master分支,应该怎么办呢?
右键-->TortoiseGit-->Switch/Checkout,选择master即可。如下图:
6. 空白处右键,会发现已经切换到master分支了。此时发现test2.txt并没有带过来,再来看看test.txt文件是否回到了从前呢?
结果显示,无论是修改还是添加,都没有影响master分支上的文件,这就是分支的作用。
4.2.3 分支合并
分支的合并就是我们说的分支merge,如果此时发现dev-0430分支上的功能是有效的,希望能合并到master,又该怎么操作呢?
PS:在合并分支前,一定要确认dev-0430分支上的代码全部提交到本地版本库了.
右键-->TortoiseGit-->Merge,选择被合并的分支,即dev-0430。如下图
点击Ok按钮,会出现下图弹框。弹框中会列出被合并的文件。如下图所示:
自此,我们发现test2.txt文件被合并过来了,打开test文件,发现内容正好是在dev-0430分支上修改的内容。至此,分支合并完成。
PS:分支合并完成后,根据实际需要,可将本地合并的最终版本push到远程分支,具体可参照章节4.1.4执行。
4.2.4 分支删除
分支被合并后并不会被自动删除,如果该分支已经完成它在开发阶段的使命,则可以大胆地将其删除。不过,一般情况下建议保留一段时间再删除。
步骤一:在相应的本地代码库里面 ,点击switch/Checkout/首先切换到比如master分支上(注意如果你想删除dev-0430,首先应切换到别的分支,只要不是dev-0430就行,否则会报错)依次如下:
步骤二:进入下图的对话框中注意左边的分支目录点选heads是本地的分支 ,选中dev-0430分支,选择删除分支,,弹出对话框点击是,完成了dev-0430的删除。
步骤三:选择remotes远程分支按照同样的步骤执行操作弹出对话框选择是就成功的删除了远程分支。由于上文提到的dev-0430并未实际提交到远端相应分支,所以此处这一步不用执行。
步骤四:执行上述步骤后,看一下本地的仓库,发现dev-0430分支已被删除。
4.3 版本管理与对比
比如本地的某个文件发生了变更,但不确定与已提交的版本中对应文件发生了哪些变更,那么可以右键-->TortoiseGit--> Show -log,选中某个提交的版本,再右键Compare with working tree,
在下面的path路径下选中对应的文件,选中 Compare with working tree(工作区未提交版本),或者Compare with base(已拉取的本地最新未变更版本),就可以在弹出的窗口中左右对比内容
4.4 拉取(pull)远端最新
此时,我们团队还有另一个成员B,他需要获取我最新修改的内容,该怎么操作呢?
首先B切换到跟我同一分支,然后右键-->Git Pull,点击确认即可,就可将我修改的内容拉取到他的本地版本库。
PS:其他成员能够拉取到最新的前提是,任何人本地的修改都已经 push 到远端。
关于代码提交的终极简化:
总结:
a) 不管什么场景,先commit提交到本地仓库再说
b) pull更新合并本地代码,保证本地版本的新鲜度
c) push提交代码
commit:commit
pull:commit+pull
push:commit+pull+push
一言以蔽之:一提(commit)二拉(pull) 三推(push)
4.5 版本回滚
先查看日志:右键-->TortoiseGit--> Show -log,确定想回滚到哪个版本(这时就体现出添加message的好处了吧)
比如想回滚到创建test.txt文件前,则点击该步操作所对应的message之前的那一个日志(origin/HEAD),然后右键-->Reset “master” to this…,表示将当前master分支上的文件回滚到这个版本,如下图
选择之后,弹出如下弹框,在Reset Type下选择你回退的类型(通常个人一般选择Hard:Reset working…..),点击OK即可
会发现,此时test.txt和 test2.txt文件都消失了,也就是回退到最初没有作任何修改时,如下图:
4.6 暂存操作
4.6.1 暂存的切换
比如我本地修改了多个文件内容,但是远程仓库上也有人更新了其中部分文件或者全部文件,这个时候,我不想将本地全部修改的文件直接上传至远程仓库,只想更新修改的多个文件里的一部分。
或者比如说我本地临时修改了部分代码,现在还没有修改到位,暂时不方便直接提交版本,但是现在有紧急的事情需要切换分支,那么怎么办呢?这时可以先把本地修改的中间版本暂存起来,
Stash Changes – TortoiseGit
Often, when you’ve been working on part of your project, things are in a messy state and you want to switch branches for a bit to work on something else. The problem is, you don’t want to do a commit of half-done work just so you can get back to this point later. The answer to this issue is the git stash command.
Stashing takes the dirty state of your working directory — that is, your modified tracked files and staged changes — and saves it on a stack of unfinished changes that you can reapply at any time (even on a different branch).
步骤1:在自己的工程项目文件夹下,鼠标右键菜单中选择【Stash changes】
步骤2:弹出的窗口中的Message文本输入框中输入自己需要的描述信息,然后点击OK
步骤3:步骤2后,弹出下图所示的处理界面,等待成功(Success)后,点击Close按钮,关闭该窗口。
步骤4:临时修改的代码暂存完毕,接下来在项目根目录下鼠标右键菜单中选择【Switch/checkout】,可以切换当前的分支,在其他分支上进行处理。
步骤5: 或者鼠标右键菜单中选择【Stash List】查看暂存代码的列表。
步骤6:在处理完成紧急事情后,如果需要再次切换到暂存的版本状态,应该怎么办呢:
鼠标右键菜单中选择【Show-log】,然后stash message信息选中暂存的版本,在下面的path中选中对应版本的,[Diff with parent],就能自动选中所有需要回退的代码版本
然后选中后,右键【Revert to this version】,在弹出的窗口点击【确定】就能切换到之前暂存的版本代码。
4.6.2 暂存的合并
如果本地未完成版本已经暂存了,且添加了相应的message,现在需要先暂时放置暂存的临时版本,需要把当前的代码拉取到最新版本,应该怎么办呢?
由于当前的暂存版本没有有效提交,直接拉取最新代码进行本地合并,势必可能出现合并冲突,为了版本的管理方便起见,可以先按照上述步骤回退到一个之前最新的有效提交版本。
然后在这个有效版本基础上,考虑合并本地的暂存版本。
4.6.3 更新项目到本地
采用拉取/pull命令更新最新的项目到本地。
方法一:
pull命令用于从远程获取代码并合并本地的版本。本地没有修改时可直接pull,如果存在修改,需要先commit后,再pull拉取合并(否则会出现失败或者本地修改丢失的情况)。
方法二:
1. 提交或暂存本地更改(如果有必要)。
2. 右键点击仓库的文件夹,选择"TortoiseGit" -> "获取(Fetch)"。
3. 在获取对话框中,点击"确定"。
4. 右键点击仓库的文件夹,选择"TortoiseGit" -> "重置(Reset)"。
PS:如果只有1,2,3步骤,并不能通过fetch拉取最新代码,而是还需要有reset
4.7 解决冲突
对于实际开发过程,经常涉及在多个分支之间切换与合并,有可能出现版本冲突导致提交不成功。
或者通常情况下开发需要在本地新建的dev分支上进行,但有时版本的快速迭代时期,比如项目组多个成员在指定的时间内反复提交多个改进版本,那么可能就会出现远程的分支与本地分支相同,多人在各自本地开发的分支也是相同的,那么将如何保证版本的有效提交与管理呢?下文介绍几种常见情况。
常见的几种冲突主要有如下几种场景:
场景一:本地相同文件冲突
场景一:本地相同文件冲突,
- 冲突场景:User1和User2修改、拉取相同文件
场景二:服务端相同文件冲突
- 冲突场景:User2和User1修改、提交、推送相同文件
场景三:服务端不同文件冲突
- 冲突场景:User2和User1修改、提交、推送不同文件
场景四:服务端文件名冲突
- 冲突场景:User2和User1重命名同一文件
具体可参考 TortoiseGit代码冲突解决方法
4.8 补充说明
暂略。