revise workflow-forking

This commit is contained in:
Jerry Lee
2014-08-31 22:30:11 +08:00
parent 2ae8472ba9
commit b6929d04b6
3 changed files with 50 additions and 39 deletions

View File

@@ -3,26 +3,26 @@
`Forking`工作流和前面讨论的几种工作流有根本的不同。
这种工作流不是使用单个服务端仓库作为『中央』代码基线,而让各个开发者都有一个服务端仓库。
这意味着各个代码贡献者不只有一个而2个`Git`仓库:一个本地私有的,另一个服务端公有的。
这意味着各个代码贡献者2个`Git`仓库而不是1个:一个本地私有的,另一个服务端公有的。
![](images/git-workflows-forking.png)
`Forking`工作流的一个主要优势是,贡献的代码可以被集成,而不需要所有人都`push`代码到仅有的中央仓库中。
`Forking`工作流的一个主要优势是,贡献的代码可以被集成,而不需要所有人都`push`代码到仅有的中央仓库中。
开发者`push`到自己的服务端仓库,而只有项目维护者才能`push`到正式仓库。
这样项目维护者可以接受任何开发者的提交,但无需给他正式代码库的写权限。
效果就是一个布式的工作流,为大型、自发性的团队(包括了不受信的第三方)提供灵活的方式来安全的协作。
效果就是一个布式的工作流,为大型、自发性的团队(包括了不受信的第三方)提供灵活的方式来安全的协作。
也让这个工作流成为开源项目的理想工作流。
:beer: 工作方式
---------------------
和其它的`Git`工作流一样,`Forking`工作流要先有一个公有的正式仓库存储在服务器上。
但一个新的开发者想要在项目上工作时,不是直接从正式仓库克隆。
但一个新的开发者想要在项目上工作时,不是直接从正式仓库克隆,而是`fork`正式项目在服务器上创建一个拷贝
而是`fork`正式项目在服务器上创建一个拷贝。这个仓库拷贝作为他个人公开仓库 ——
其它开发者不允许`push`到这个仓库,但可以`pull`到修改(后面我们很快就会看这点很重要)。
在创建了自己服务端拷贝之后,开发者执行`git clone`命令克隆仓库到本地机器上,作为私有的开发环境,和之前的工作流一样
这个仓库拷贝作为他个人公开仓库 ——
其它开发者不允许`push`到这个仓库,但可以`pull`到修改(后面我们很快就会看这点很重要)。
在创建了自己服务端拷贝之后,和之前的工作流一样,开发者执行[`git clone`命令](https://www.atlassian.com/git/tutorial/git-basics#!clone)克隆仓库到本地机器上,作为私有的开发环境。
要提交本地修改时,`push`提交到自己公有仓库中 —— 而不是正式仓库中。
然后,给正式仓库发起一个`pull request`,让项目维护者知道有更新已经准备好可以集成了。
@@ -30,19 +30,20 @@
为了集成功能到正式代码库,维护者`pull`贡献者的变更到自己的本地仓库中,检查变更以确保不会让项目出错,
[合并变更到自己本地的`master`分支](https://www.atlassian.com/git/tutorial/git-branches#!merge)
然后`push`到服务器的`master`分支
然后[`push`](https://www.atlassian.com/git/tutorial/remote-repositories#!push)`master`分支到服务器的正式仓库中
到此,贡献的提交成为了项目的一部分,其它的开发者应该执行`pull`操作与正式仓库同步自己本地仓库。
### 正式仓库
`Forking`工作流中,『官方』仓库的叫法只是一个约定,理解这点很重要。
技术观点上,各个开发者仓库和正式仓库在`Git`看来没有任何区别。
事实上,让正式仓库之所以正式是是看公开仓库的维护者是谁
技术上来看,各个开发者仓库和正式仓库在`Git`看来没有任何区别。
事实上,让正式仓库之所以正式的唯一原因是它是项目维护者的公开仓库
### `Forking`工作流的分支使用方式
所有的个人开仓库实际上只是为了方便和其它的开发者共享分支。各个开发者应该用分支隔离各个功能,就像在[功能分支工作流](workflow-feature-branch.md)
和 [`Gitflow`工作流](workflow-forking.md)一样。唯一的区别是这些分支被共享了,而功能分支工作流和`Gitflow`工作流是直接`push`到正式仓库中
所有的个人开仓库实际上只是为了方便和其它的开发者共享分支。
各个开发者应该用分支隔离各个功能,就像在[功能分支工作流](workflow-feature-branch.md)和[`Gitflow`工作流](workflow-forking.md)一样
唯一的区别是这些分支被共享了。在`Forking`工作流中这些分支会被`pull`到另一个开发者的本地仓库中,而在功能分支工作流和`Gitflow`工作流中是直接被`push`到正式仓库中。
:beer: 示例
---------------------
@@ -51,11 +52,11 @@
![](images/git-workflows-forking-1.png)
和任何使用`Git`项目一样,第一步是创建在服务器上一个正式仓库,让团队成可以访问。
和任何使用`Git`项目一样,第一步是创建在服务器上一个正式仓库,让所有团队成员都可以访问
通常这个仓库也会作为项目维护者的公有仓库。
[公有仓库应该是裸仓库](https://www.atlassian.com/git/tutorial/git-basics#!init),不管是不是正式代码库。
所以项目维护者会运行下面的命令来搭建正式仓库:
所以项目维护者会运行下面的命令来搭建正式仓库:
```bash
ssh user@host
@@ -64,23 +65,34 @@ git init --bare /path/to/repo.git
`Bitbucket``Stash`提供了一个方便的`GUI`客户端以完成上面命令行做的事。
这个搭建中央仓库的过程和前面提到的工作流完全一样。
如果有代码库,维护者也要`push`到这个仓库中。
如果有现存的代码库,维护者也要`push`到这个仓库中。
### 开发者`fork`正式仓库
![](images/git-workflows-forking-2.png)
下一步,各个开发者会各自的公有仓库,用熟悉的`git clone`命令
其它所有的开发需要`fork`正式仓库
可以用`git clone`命令[用`SSH`协议连通到服务器](https://confluence.atlassian.com/display/BITBUCKET/Set+up+SSH+for+Git)
拷贝仓库到服务器另一个位置 —— 是的,`fork`操作基本上就只是一个服务端的克隆。
`Bitbucket``Stash`上可以点一下按钮就让开发者完成仓库的`fork`操作。
在这个示例中,假定用`Bitbucket`托管了仓库。记住,这样的话各个开发者需要各自的`Bitbucket`账号,
使用下面命令克隆服务端仓库:
这一步完成后,每个开发都在服务端有一个自己的仓库。和正式仓库一样,这些仓库应该是裸仓库。
### 开发者克隆自己`fork`出来的仓库
![](images/git-workflows-forking-3.png)
下一步,各个开发者要克隆自己的公有仓库,用熟悉的`git clone`命令。
在这个示例中,假定用`Bitbucket`托管了仓库。记住,如果这样的话各个开发者需要有各自的`Bitbucket`账号,
使用下面命令克隆服务端自己的仓库:
```bash
git clone https://user@bitbucket.org/user/repo.git
```
相比前面介绍的工作流只用了一个`origin`远程别名指向中央仓库,`Forking`工作流需要2个远程别名 ——
一个指向正式仓库,另一个指向开发者自己的服务端仓库。别名的名可以任意命名,常见的约定是使用`origin`作为远程克隆的仓库的别名
一个指向正式仓库,另一个指向开发者自己的服务端仓库。别名的名可以任意命名,常见的约定是使用`origin`作为远程克隆的仓库的别名
(这个别名会在运行`git clone`自动创建),`upstream`(上游)作为正式仓库的别名。
```bash
@@ -94,13 +106,13 @@ git remote add upstream https://bitbucket.org/maintainer/repo
git remote add upstream https://user@bitbucket.org/maintainer/repo.git
```
在克隆和`pull`正式仓库时,需要提供用户的密码。
这时在克隆和`pull`正式仓库时,需要提供用户的密码。
### 开发者开发自己的功能
![](images/git-workflows-forking-4.png)
在刚克隆的本地仓库中,开发者可以像其它工作流一样的编辑代码、提交修改和新建分支
在刚克隆的本地仓库中,开发者可以像其它工作流一样的编辑代码、[提交修改](https://www.atlassian.com/git/tutorial/git-basics#!commit)和[新建分支](https://www.atlassian.com/git/tutorial/git-branches#!branch)
```bash
git checkout -b some-feature
@@ -108,13 +120,13 @@ git checkout -b some-feature
git commit -a -m "Add first draft of some feature"
```
所有的修改都是私有的直到`push`到自己公开仓库中。如果正式项目已经往前走了,可以用`git pull`命令获得
所有的修改都是私有的直到`push`到自己公开仓库中。如果正式项目已经往前走了,可以用[`git pull`命令](https://www.atlassian.com/git/tutorial/remote-repositories#!pull)获得新的提交
```bash
git pull upstream master
```
由于开发应该在专门的功能分支上开发`pull`操作是[快进合并](https://www.atlassian.com/git/tutorial/git-branches#!merge)。
由于开发应该在专门的功能分支上工作`pull`操作结果会都是[快进合并](https://www.atlassian.com/git/tutorial/git-branches#!merge)。
### 开发者发布自己的功能
@@ -122,34 +134,34 @@ git pull upstream master
一旦开发者准备好了分享新功能,需要做二件事。
首先,通过`push`他的贡献代码到自己的公开仓库中,让其它的开发者都可以访问到。
他的`origin`远程别名应该已经有了,所以要做就是:
他的`origin`远程别名应该已经有了,所以要做就是:
```bash
git push origin feature-branch
```
和之前的工作流的差异就在于`origin`远程别名指向开发者自己的服务端仓库,而不是正式仓库。
这里和之前的工作流的差异`origin`远程别名指向开发者自己的服务端仓库,而不是正式仓库。
然后,开发者要通知项目维护者,想合并他的新功能到正式库中。
`Bitbucket``Stash`提供了`Pull Request`按钮,弹出表单让你指定哪个分支要合并到正式仓库。
一般你会想集你的功能分支到上游远程仓库的`master`分支。
第二件事,开发者要通知项目维护者,想合并他的新功能到正式库中。
`Bitbucket``Stash`提供了[`Pull Request`](https://confluence.atlassian.com/display/STASH/Using+pull+requests+in+Stash)按钮,弹出表单让你指定哪个分支要合并到正式仓库。
一般你会想集你的功能分支到上游远程仓库的`master`分支
### 项目维护者集成开发者的功能
![](images/git-workflows-forking-6.png)
当项目维护者收到`pull request`,他要做的是决定是否集成到正式代码库中。有二种方式来做:
当项目维护者收到`pull request`,他要做的是决定是否集成到正式代码库中。有二种方式来做:
1. 直接在`pull request`中查看代码
1. `pull`代码到他自己的本地仓库,再手动合并
第一种做法更简单,维护者可以在`GUI`中查看变更的差异,做评注和执行合并。
但如果出现了合并冲突,需要第二种做法来解决。这种情况下,维护者需要从开发者服务端仓库[`fetch`](https://www.atlassian.com/git/tutorial/remote-repositories#!fetch)功能分支,
但如果出现了合并冲突,需要第二种做法来解决。这种情况下,维护者需要从开发者服务端仓库[`fetch`](https://www.atlassian.com/git/tutorial/remote-repositories#!fetch)功能分支,
合并到他本地的`master`分支,解决冲突:
```bash
git fetch https://bitbucket.org/user/repo feature-branch
# Inspect the changes
# 查看变更
git checkout master
git merge FETCH_HEAD
```
@@ -160,13 +172,13 @@ git merge FETCH_HEAD
git push origin master
```
注意维护者的`origin`是指向他自己公有仓库的,即是项目的正式代码库。到此,开发者的贡献完全集成到了项目中。
注意维护者的`origin`是指向他自己公有仓库的,即是项目的正式代码库。到此,开发者的贡献完全集成到了项目中。
### 开发者和正式仓库做同步
![](images/git-workflows-forking-7.png)
由于正式代码库往前走了,其它的开发需要做同步:
由于正式代码库往前走了,其它的开发需要和正式仓库做同步:
```bash
git pull upstream master
@@ -180,9 +192,9 @@ git pull upstream master
不是直接通过单个中央仓库来分享分支,而是把贡献代码发布到开发者自己的服务端仓库中。
示例中解释了,一个贡献如何从一个开发者流到正式的`master`分支中,但同样的方法可以把贡献集成到任一个仓库中。
比如,如果团队的几个人协作实现一个功能,可以在开发之间用相同的方法分享变更,不涉及路面仓库。
比如,如果团队的几个人协作实现一个功能,可以在开发之间用相同的方法分享变更,完全不涉及正式仓库。
这使得`Forking`工作流对于松散组织的团队来说是个强大的工具。任一开发者可以方便地和另一开发者分享变更,任何分支都能有效地合并到正式代码库。
这使得`Forking`工作流对于松散组织的团队来说是个非常强大的工具。任一开发者可以方便地和另一开发者分享变更,任何分支都能有效地合并到正式代码库
-----------------