Gitee使用教程

发布时间:2023-05-23

一、注册与登录

注册账号很简单,在Gitee主页上点击“注册”按钮,然后填写用户名、邮箱及密码即可完成注册。使用已有的QQ、微博、GitHub等第三方账号也可以直接登录。 登录后可以进行各种操作,如创建、上传、下载、更新代码库等。

# 注册示例代码
$ curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \
   "email": "user@example.com", \
   "password": "P@ssword", \
   "username": "user" \
 }' 'https://gitee.com/api/v5/users'
# 登录示例代码
$ curl -X POST --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/json' -d 'grant_type=password&username=user@example.com&password=P@ssword&client_id=CLIENT_ID&client_secret=CLIENT_SECRET' 'https://gitee.com/oauth/token'

二、创建和管理代码库

创建代码库的步骤如下:

  1. 点击页面中的“创建仓库”按钮
  2. 填写仓库信息,如名称、描述、访问权限等
  3. 根据需要,选择公共或私有仓库
  4. 初始化 Readme、License 等文件
  5. 选择创建方式,如初始化或从已有代码库复制等
    创建完成后,可以进行代码的上传、下载、更新等操作。
# 创建示例代码
$ curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \
   "name": "project-name", \
   "path": "project-path", \
   "visibility_level": 0, \
   "description":"description of project", \
   "readme_type":"markdown", \
   "license_template":"mit" \
 }' 'https://gitee.com/api/v5/user/repos'

三、协作与合并代码

在Gitee中,可以邀请其他人协作代码库,共同开发、维护项目。步骤如下:

  1. 在代码库的设置中,选择“协作者设置”
  2. 输入邀请人的用户名或邮箱,并设置权限(开发者、发布者、管理员等)
  3. 邀请后,他们将可以在代码库中进行提交、合并等操作
    在多人协作中,也可以使用 Pull Request 的方式,进行代码合并。具体步骤如下:
  4. 从 Gitee 上 fork 一份代码库到自己的账号下
  5. 将 fork 的代码库 Clone 至本地
  6. 在本地创建并切换新分支
  7. 对代码库进行修改、提交本地分支
  8. 向原始代码库发起Pull Request请求,提交修改的分支。原始代码库管理员审核后通过,可以合并修改的分支到原始代码库。
# 添加协作者示例代码
$ curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \
   "usernames": [ \
     "user1", \
     "user2" \
   ], \
   "permission":"dev" \
 }' 'https://gitee.com/api/v5/repos/:owner/:repo/collaborators'
# Pull Request 示例代码
$ git clone https://gitee.com/:owner/:repo
$ cd :repo
$ git checkout -b new_branch
$ # 修改代码
$ git add .
$ git commit -m "update code."
$ git push origin new_branch
$ # 向原始代码库发起Pull Request

四、持续集成和发布

Gitee中支持持续集成、持续部署流程。可以与 Jenkins、Travis CI等流行的CI/CD工具集成,自动化进行构建测试、打包及部署。 使用Gitee持续集成可以做到以下几个方面:

  1. 自动化构建、测试和部署
  2. 定期备份、还原数据
  3. 监控应用运行状态
  4. 快速回滚到任意版本
# Jenkins 集成示例
# 在 Jenkins 上安装「Gitee Plugin」插件
# 在 Gitee 上创建 AccessToken,用于 Jenkins 集成认证
# 在 Jenkins 上新建任务,在 Git 配置中填写 Gitee 代码库的地址和 AccessToken 等信息,并配置自动构建、测试、部署等流程

五、安全保障

Gitee 采用多层安全防护措施,保障用户信息和数据的安全性:

  1. 支持多种登录认证方式,如密码、短信验证码、二维码、GitHub等
  2. 支持 DDoS 攻击防护、WAF、CDN、SSL等安全加固
  3. 数据存储多副本备份、异地灾备、定期数据备份等措施
  4. 对外提供 API 接口,支持 OAuth2 鉴权、API 密钥、IP 白名单 等控制方式
  5. 提供静态文件镜像服务、防盗链、缓存、压缩等功能
# 删除用户示例代码
$ curl -X DELETE --header 'Authorization: Token ACCESS_TOKEN' 'https://gitee.com/api/v5/user'