HLT团队内部GitLab使用指南

经过老师的初步考虑,我们暂时放弃Phabricator,完全使用GitLab来管理我们的项目。这个决定老师综合考虑了各方面因素,而且GitLab口碑出众,是个潮牌,对以后的工作也大有裨益,相信大家会喜欢上它的,每天不用两把都不舒服。

一、第三方评价

(一)Slant评价

  2017年Slant社区关于"最好的web自托管Git仓库是什么?"的讨论里,Gitlab排名第一,Phabricator排名第三。也能证明,Gitlab对于我们这样长期50-100人且流动性强的校园团队来讲,是完全够用的。

详情可看这里.

(二)Forrester关于Gitlab CI/CD评价

  CI/CD是Gitlab的持续集成/持续交付功能,我们现在还不需要使用,它在2017年Forrester中排名第一。


  GitLab cited as a Leader in The Forrester Wave™: Continuous Integration Tools, Q3 2017 report released today.

Forrester的评价:“GitLab’s vision is to serve enterprise-scale, integrated software development teams that want to spend more time writing code and less time maintaining their tool chain.”

二、我们如何使用

我们的GitLab地址已经发布到组内的wiki上了,大家只需要记住:

  • 外网的GitLab一行代码都不存,这是学生、老师和合作单位互相交流issues的平台。
  • 内网的GitLab存我们的代码,管理我们的项目。

为什么不用一个GitLab主要是考虑到安全问题,代码放内网肯定是最安全的。

基础使用

如果你有基础,首先在Gitlab新建一个项目,然后看看项目下面一个简单的tutorial就可以了:
命令行指令

Git 全局设置

git config --global user.name "xxx"
git config --global user.email "xxx@gmail.com"

创建新版本库

git clone http://192.168.131.172:9999/xxx/projectname
cd projectname
touch README.md
git add README.md
git commit -m "add README"
git push -u origin master

已存在的文件夹

cd existing_folder
git init
git remote add origin http://192.168.131.172:9999/xxx/projectname
git add .
git commit -m "Initial commit"
git push -u origin master

已存在的 Git 版本库

cd existing_repo
git remote add origin http://192.168.131.172:9999/xxx/projectname
git push -u origin --all
git push -u origin --tags

但是光看这些还是不太够,我们举点实际的例子讲解下,以后忘了可以再查阅。

场景1. 已经有一个正在做的项目或者做完的项目,如何使用git并添加进远程仓库GitLab中?

首先假设我们有个工程ch02(你可以找一个自己的项目跟着做)如下:

我们看左边的sideBar里面的工程目录,文件有:

  • digits文件夹:数据文件
  • datingTestSet.txt:数据文件
  • datingTestSet2.txt:数据文件
  • kNN.py:代码文件
  • test.py:代码文件

1.1在工程中使用git版本控制

我们进入已有的工程目录下:执行命令:

git init

这样我们就在项目中使用上了git,并且默认进入了master分支。

现在我们使用命令

git status

查看项目的追踪状态,这就像我们平时使用ls命令一样。

可以看到git提示我们,我们有一些文件没有追踪,它们是我们已经提到的:

  • digits文件夹:数据文件
  • datingTestSet.txt:数据文件
  • datingTestSet2.txt:数据文件
  • kNN.py:代码文件
  • test.py:代码文件

1.2 忽略大的数据文件

其中有一些东西是我们不需要追踪的,甚至不能追踪的,比如数据文件,原因有二:

  1. 对项目没有意义,且传到GitLab上会有泄漏数据的风险。
  2. 因为他们很大,动辄几G,追踪他们会使git操作变得巨慢。

所以我们需要了解git中的.gitignore文件,拆开看就是git ignore,很直白,他可以告诉git,哪些文件我们忽略不追踪。
我们直接用编辑器编辑文件(看你个人喜好),这里用的vim编辑如下:

可以看到语法非常简单,即忽略所有数据文件:

  • digits文件夹
  • datingTestSet.txt
  • datingTestSet2.txt

如果你有其他大型项目开发,这里有模板可以参考,但是我们做NLP的应该暂时可以不用管,暂时还用不上。

现在我们再次使用git status查看:

就发现我们成功的忽略掉了数据文件,只剩下代码文件了。

1.3 把本地仓库同远程GitLab仓库关联

首先我们要进入GitLab创建一个空仓库,用于接收这个本地项目。仓库的项目名称最好和本地一样,免得自己混淆。


权限说明:

  • Private: 私人仓库,项目只有自己能看到,其他人都不能看到,包括系统管理员。
  • Internal: 项目只有登录账户可看。
  • Public: 项目即使是游客都能看到。

创建好后可以看到这个界面:


我们复制好git仓库地址,在我这边是http://192.168.131.172:9999/joezhow/ch02.git,然后进入命令行,输入:

git add . && git status

把代码提交到git的缓存区,然后输入:

git commit -m "保存已经完成的kNN代码"

把代码提交到git的本地仓库。


现在关联远程仓库,输入:

git remote add origin http://192.168.131.172:9999/joezhow/ch02.git

然后我们就把本地仓库和远程仓库建立起了一条关联渠道,git remote是和git远程操作相关的命令,add origin是指把仓库地址http://192.168.131.172:9999/joezhow/ch02.git,以别名origin保存下来,方便我们的push操作,不然每次push都写这么大串地址十分不方便,我们可以通过

git remote -v

命令查看详细内容


关于这个fetch我们后文会讲,首先我们讲push。

现在我们已经有了通道,我们通过命令

git push -u origin master

这个命令会把master分支传到远程仓库origin的master分支上,-u参数可加可不加,加了会更好,为什么我现在也说不清楚。

然后它可能会叫你输入你Gitlab的账号和密码,输入过后,代码即push到远程仓库了。


场景2. 项目被师兄添加了高端新代码,我怎么更新?

比如我们的ch02项目中,我今天的工作就是做了kNN,像上图那样就已经做完了,然后师兄又做了另一个更加高效的kNN实现代码kNN1.py,并且上传到远程仓库,如下图:


而我们本地仓库没有kNN1.py文件,所以我们需要把本地仓库ch02项目的代码更新,我们获得远程仓库的最新版本:

git fetch origin master

这句话的意思是从远程的origin仓库的master分支下载代码到本地的origin master,这条语句是很安全的,可以随意使用,因为它不会覆盖掉本地仓库的代码。

接下来我们对比本地master和origin master代码有哪些不同:

git log -p master.. origin/master

这里按行解释下:

    1. commitID
    1. 作者
    1. 提交时间
    1. commit的内容
    1. 添加了一个文件kNN1.py
    1. 添加的内容

然后我们需要这份高效的代码,使用命令:

git merge origin/master

即可合并到本地仓库。

场景3.多人协作中,学弟应该如何正确push,并给Mentor发起Merge?

多人协作中,我们要规范在dev分支开发,主master分支只接受稳定版本,因此,在Gitlab的项目权限中仅有少数的mentor可以对代码的master分支进行merge,即有权限更新master分支代码。这样可以保证新人不会随便把质量不好的代码push或者merge到主分支上。所以我们实际开发使用dev开发,mentor也应该如此。

这里假设学弟写了个比kNN1更高效kNN2,add commit后,输入以下命令,把dev分支push到origin的dev分支上:

git push -u origin dev

师弟需要进入Gitlab,进入dev分支中会发现项目比master分支多一个kNN2.py文件,最重要的是多出了一个Create merge request的按钮:

这里要填写一些信息:


最重要的是这里的指派,把这个request指派给哪个mentor,然后提交,接下来就是mentor的code review任务。

师兄就会有一个合并请求和待办事项:


我们可以查看查看变更,直接在Gitlab的网页在完成merge,也可以使用Check out branch:

在本地命令行完成变更。

场景4.在项目中添加member

我们找到项目的设置->成员:



在里面就可以添加新成员了:


总结

这样一个简单的团队workflow就讲完了,同学们不会的问题,请在外网的gitlab的gitlab-question/issues里留下问题,后续可以更新。

结语:苏州大学HLT团队(人类语言技术研究所,所长张民),是从新加坡回国的年轻团队,所长张民担任苏州大学副院长,国家杰出青年学者,本团队长期招收有梦想的优质本科毕业生。主攻方向为人工智能最重要的引擎NLP技术,组内有如知识图谱、语音翻译、句法分析等各种方向,毕业大半去往BAT或感兴趣深造读博,欢迎感兴趣的同学联系报考。详情请看:苏州大学人类语言技术研究所

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,198评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,663评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,985评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,673评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,994评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,399评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,717评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,407评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,112评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,371评论 2 241
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,891评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,255评论 2 250
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,881评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,010评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,764评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,412评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,299评论 2 260

推荐阅读更多精彩内容