码云(Gitee.com)帮助文档 V1.2
码云使用手册
目录
1、什么是码云..........................................................................................................................................4
1.1、什么是码云(Gitee.com)..................................................................................................... 4
1、什么是码云(Gitee.com)................................................................................................4
2、码云主要功能.....................................................................................................................4
3、码云协作模式.....................................................................................................................4
1.2、码云亮点.................................................................................................................................. 6
1.3、探索码云.................................................................................................................................. 7
1.4、码云平台 IDEA 系列的插件使用............................................................................................ 8
1. 插件安装...............................................................................................................................8
2. 登陆并拉取项目...................................................................................................................9
1. 启动 idea,选择 Check out from Version Control - 码云....................................................9
2. 输入用户名和密码,登陆...................................................................................................9
3. 点击选框中的向下箭头,会显示当前用户在码云上的所有项目...................................9
4. 可选择任意项目进行 clone................................................................................................. 9
1. 选择 File - settings.................................................................................................................9
2. 选择 Version Control - 码云..................................................................................................9
1. 选择 VCS - Checkout from Version Control - 码云............................................................... 9
2. 其他步骤同上.....................................................................................................................10
3. push 代码............................................................................................................................ 10
1. 添加文件.............................................................................................................................10
2. 选择 commit....................................................................................................................... 10
3. 填写 commit 信息...............................................................................................................10
4. 选择 push............................................................................................................................ 10
5. 将代码 push 到线上........................................................................................................... 10
4. 托管本地项目到码云.........................................................................................................10
1. 选择 VCS - Import into Version Control - 托管项目到码云...............................................10
2. 填写项目信息,可选择公有或私有.................................................................................10
3. 选择文件,填写 commit 信息。点击 OK 即可................................................................10
5. Tasks 关联码云 Issue..........................................................................................................10
6. 创建代码片段.....................................................................................................................11
1.5、常用工具及插件教程............................................................................................................ 12
1.6、码云使用容量说明................................................................................................................ 13
1、项目数量:.......................................................................................................................13
2、项目容量...........................................................................................................................13
3、附件容量...........................................................................................................................13
4、成员人数...........................................................................................................................13
1.7、Git 大全.................................................................................................................................. 14
2、创建码云账号....................................................................................................................................14
2.1、创建码云账号........................................................................................................................ 14
2.2、CSDN CODE 项目整体迁移到码云平台................................................................................ 16
3、代码托管............................................................................................................................................17
3.1、创建第一个项目.................................................................................................................... 17
1、创建项目...........................................................................................................................17
2、本地初始化一个项目.......................................................................................................17
3、完成第一次提交...............................................................................................................18
3.2、公钥认证管理........................................................................................................................ 19
1.如何生成 ssh 公钥.............................................................................................................. 19
2.怎么添加用户 ssh key?....................................................................................................... 20
3.3、建立主页................................................................................................................................ 20
1. 使用前须知.........................................................................................................................21
2. 一个小白的 Pages 搭建之旅..............................................................................................21
3. 已经有 Pages 项目如何部署到码云的 Pages...................................................................22
4. Pages 进阶,使用 Jekyll 生成自己的静态网页................................................................ 23
什么是 G 币?......................................................................................................................................... 68
可以用 G 币做什么?............................................................................................................................. 69
如何获取 G 币?..................................................................................................................................... 69
1. 新注册用户获得 2G 币....................................................................................................................... 69
2. 邀请一位用户完成注册并新建项目可得 1G 币............................................................................... 69
3. 改进码云(Gitee.com)的建议被采纳:5G 币(被打上标签即视为采纳).....................................69
4. 不定期发布的各种形式的 G 币 悬赏活动(请关注 码云微博 及 码云微信公众号)..................69
一、码云企业版介绍..............................................................................................................................69
我已经有了码云个人版, 为什么要用码云企业版?................................................................... 69
功能对比:..................................................................................................................................... 69
服务对比:..................................................................................................................................... 69
二、关于企业版套餐介绍......................................................................................................................69
首先,您的项目与目标项目必须存在差异,这样才能提交,比如这样:.........................................87
1. 什么是个性地址??..........................................................................................................................90
2.为什么无法修改个性地址?...............................................................................................................90
一、通过 https 方式............................................................................................................................... 95
二、通过 ssh 方式...................................................................................................................................95
1.获取仓库代码:........................................................................................................................ 104
一、如何贡献于开源项目....................................................................................................................115
二、如何开启开源项目........................................................................................................................115
三、为开源项目寻找参与者................................................................................................................116
四、建立开源欢迎社区........................................................................................................................116
五、如何做好开源项目的维护者........................................................................................................117
六、如何领导和治理开源社区............................................................................................................117
Git LFS 是什么........................................................................................................................................117
如何在 Gitee 上 使用 LFS......................................................................................................................118
1.Git 的安装...........................................................................................................................................125
1. ssh 方式:需要在本机配置 ssh....................................................................................................... 126
1.修改仓库名................................................................................................................................ 127
2.添加一个仓库............................................................................................................................ 127
3.查看当前仓库对应的远程仓库地址........................................................................................ 128
4.修改仓库对应的远程仓库地址................................................................................................ 128
1、什么是码云
1.1、什么是码云(Gitee.com)
1、什么是码云(Gitee.com)
----------
码云(Gitee.com)是专为开发者提供的稳定、高效、安全的云端软
件开发协作平台。
无论是个人、团队、或是企业,都能够用码云实现代码托管、项目
管理、协作开发。
码云于 2013 年正式推出,由开源中国基于 Gitlab 所开发,我们在
Gitlab 的基础上做了大量的改进和定制开发,致力于为国内开发者提
供优质稳定的托管服务。目前已成为国内最大的代码托管系统。
2、码云主要功能
----------
码云除了提供最基础的 Git 代码托管之外,还提供代码在线查看、历
史版本查看、Fork、Pull Request、打包下载任意版本、Issue、
Wiki 、保护分支、代码质量检测、PaaS 项目演示等方便管理、开
发、协作、共享的功能。
3、码云协作模式
----------
对于一个开源项目,从开发角度讲大体上分为两类人群,一类称为
核心开发团队,他们可以向保存源代码的版本库提交,即对源代码
的修改具有最终的决定权。另外一类称为贡献者,他们不属于核心
开发团队,虽然也能看到源代码,但无权向版本库提交修改。
采用传统的集中式版本控制系统(如 SVN )的开源项目,这两个群
体的用户体验都不是太好。如图 1-1 所示,项目的贡献者(非核心
成员)很不“高兴”,因为他们即便有修改源代码的能力和渴望,也
不能直接向版本库提交,要想成为提交者需要一个很长的建立信任
的过程。然而即便是核心开发团队的成员,体验也不是太好,因为
凡是涉及到版本库的操作(检入、检出、查看日志等)都需要在联
网的状态下进行,网络带宽对用户体验影响相当大。
图片地址:https://static.oschina.net/uploads/img/201705/18181722_ePPY.jpg
图 1-1:使用集中式版本控制系统
Git 等分布式版本控制系统的出现,彻底颠覆了原有代码管理的组织
模式。使用 Git,不再依赖唯一的、集中式的版本库,而是每个开发
者本地都拥有一份完整的版本库。Git 并不排斥集中式的使用模式,
但更倾向于将集中式版本库称为共享版本库。核心开发团队的成员
和贡献者(非核心成员)都可以从共享版本库克隆一份本地版本
库,但只有核心团队成员才可以将自己本地版本库的提交推送到共
享版本库上。如图 1-2 所示。
图片地址:https://static.oschina.net/uploads/img/201705/18181743_LKNF.jpg
图 1-2:使用分布式版本控制系统
使用 Git 做版本控制(如图 1-2 所示),核心开发团队非常“高兴”,
因为他们和共享版本库之间不必一直保持连接状态,诸如查看日
志、提交、创建分支等几乎全部操作都(脱离网络)在本地的版本
库中完成。项目贡献者(非核心成员)也不再那么沮丧,因为版本
库人人皆可更改(当然是对本地版本库而言)。稍微让贡献者感到
困难的就是如何将自己对项目的改进被核心开发团队所了解并接
纳。Git 提供了多种途径,一个方法是先用 git format-patch 命令将本
地提交转换为补丁文件或补丁文件序列,再通过邮件发送给核心开
发团队。另外一个办法就是搭建一个自己专有的共享版本库,通过
邮件创建一个拉拽请求(Pull Request),让核心团队的开发者到自
己的版本库来抓取(Pull)。
图片地址:https://static.oschina.net/uploads/img/201705/18181806_8HN7.jpg
图 1-3:码云的协同模式
使用码云,无论是项目的核心开发团队,还是普通的项目贡献者都
工作得非常“愉快”。创建项目变得非常轻松,创建者只需在码云上
点击一下鼠标即可创建一个新版本库,通过简单的 Web 操作即可完
成项目授权进而组建项目核心团队。在码云中,非核心团队成员参
与项目也很容易。先找到自己希望参与的项目,然后只需在 Web 上
点击一下鼠标即可在自己的托管空间下创建一个派生(fork)的项
目,并对派生项目的版本库具有读写的完全权限,就好像这个项目
原本就是由自己创立的那样。当贡献者完成开发并向自己派生的版
本库推送后,可以通过码云的 Web 界面向项目的核心开发团队发送
一个 Pull Request,请求审核。项目的核心团队收到 Pull Request 后
审核代码,审核通过后可以直接通过 Web 界面执行合并操作接纳贡
献者的提交。
1.2、码云亮点
图片地址:https://static.oschina.net/uploads/img/201708/17172039_0ETd.png
图片地址:https://static.oschina.net/uploads/img/201708/17172208_4YSD.png
图片地址:https://static.oschina.net/uploads/img/201708/17172230_QzRf.png
1.3、探索码云
打开浏览器,访问网址:https://gitee.com。
图片地址:https://static.oschina.net/uploads/img/201707/17191633_7H8o.png
图 1-4:码云的首页
----------
作为一个新手,如果想要了解码云上的热门开源项目,那么可以从
导航条中的【发现】开始。图 1-5 显示通过对开源项目数据的分析
得到的趋势。
图片地址:https://static.oschina.net/uploads/img/201704/01141935_bVhT.jpg
图 1-5:开源项目动态趋势
----------
图 1-6 显示了码云托管项目编程语言的动态分布,可以帮助程序员
在找工作时选择更热门的编程语言,实时了解行业信息。:-)
图片地址:https://static.oschina.net/uploads/img/201704/01142502_1paf.jpg
----------
导航栏中【企业服务】,是码云专门为公司提供自托管的代码存取
及版本管理服务。码云企业版包括了码云免费版的所有主要功能,
包括代码浏览、问题追踪、Wiki、质量检测、项目演示、团队协作
等,此外,还提供了更强大的安全告警功能以及详细的企业资源、
人员贡献、项目进度等的统计功能。
图片地址:https://static.oschina.net/uploads/img/201707/17191202_jrPc.png
码云企业版为了满足不同团队规模的需求,灵活设置了不同的版
本,甚至还提供了小额度的企业免费版。
图片地址:https://static.oschina.net/uploads/img/201704/01145325_xFoC.jpg
1.4、码云平台 IDEA 系列的插件使用
1. 插件安装
注意:码云 IDEA 插件已由 gitosc 更名为 gitee。
新版插件 gitee 菜单已经和 git 菜单合并
方法一
1. 启动 idea
2. 选择 Configure - Plugins
3. 选择 Browse repositories...
4. 搜索 gitee,安装插件
5. 重启 idea 即可
图片地址:https://static.oschina.net/uploads/img/201712/01141617_wXCn.gif
方法二
1. 选择 File - Settings
2. 选择 Plugins
3. 选择 Browse repositories...
4. 搜索 gitee,安装插件
5. 重启 idea 即可
图片地址:https://static.oschina.net/uploads/img/201712/01141922_Njrt.gif
方法三
插件地址为:https://plugins.jetbrains.com/plugin/8383-gitee 直接下