新手指引

本文帮助你快速认识和上手云效代码管理应用。

前提条件

  1. 如需体验本地命令行操作,请先安装 Git 工具,安装方法参见安装Git

  2. 如需体验 SSH 方式克隆和提交代码,请先在平台账号内配置 SSH 公钥,配置方法参见配置 SSH 密钥

背景信息

云效代码托管 Codeup 可通过以下入口访问:

image

步骤一:新建第一个代码库

  1. 登录 https://codeup.aliyun.com,单击首页右上角添加库按钮。

image
  1. 在新建对话框中完成以下信息的填写:

    • 设置代码库名称:代码库的名称,用于代码库命名,支持输入字母和数字、 '_'、 '.'和'-',且只能以字母、数字或'_'开头。

    • 设置代码库路径。

    • 设置公开性:设置代码库可见性,企业公开库对企业内成员(不包含外部成员)可见,私有仓库仅限代码库成员可见,参见平台权限设置

    • 设置代码库描述:代码库的简单介绍。

    • 设置 readme、.gitignore 、存储加密等高级初始化选项。

image
  1. 单击确认,成功创建你的第一个代码库。

说明

如已经使用其他代码托管平台,云效提供代码快速导入能力,参见迁移/导入三方代码库

步骤二:提交第一行代码

云效代码管理支持两种方式进行代码提交:在网页端修改和提交,以及在本地 Git 客户端代码提交。

方法一:网页端代码提交

  1. 在网页端进入已创建的代码库。

  2. 选择某个文件,以 README.md 为例,单击右上角的编辑按钮。

image
  1. 修改部分内容,例如在 README.md 文末增加如下内容,修改后点击保存。

    //说明readme文档作用
    >readme 文档用来承载代码库的说明
  2. 在弹窗中撰写提交说明。

填写提交说明的标题和详细描述,描述这次修改的原因。如不填写,会使用默认的提交说明。

image

说明

在提交说明的标题中,尽量使用英文,长度以不超过50个字节为宜,且末尾无需添加句点。

  1. 点击立即提交,将文件修改提交到相应的分支(如 master 分支)。

  2. 验证结果:单击库菜单的提交列表,查看确认刚才的修改已提交到代码库。

image

方法二:本地 Git 客户端代码提交

本地使用 Git 需先进行安装,参见安装Git

克隆代码至本地

  1. 在网页端进入已创建的代码库。

  2. 单击库首页右上角克隆/下载按钮,获取克隆地址。

可以选择 SSH 或者 HTTP 的方式进行克隆,分别对应不同的克隆地址。

image

  1. 克隆代码库。

    1. 通过 HTTPS 协议克隆。

      说明

      首次克隆前请先配置克隆账号和密码,参见配置 HTTPS 克隆账号密码

      • 在源文件的代码库地址栏,选择“HTTPS”,复制地址。

      • 在 Git Bash 中输入克隆命令。

        git clone https://codeup.aliyun.com/your-company/xxx.git # 换成你复制的代码库地址

        按照终端提示输入已设置的克隆账号与密码。

    2. 通过 SSH 协议克隆。

      说明

      首次克隆前请先配置 SSH 公钥,参见配置 SSH 密钥

      • 在源文件的代码库地址栏,选择“SSH”,复制地址。

      • 在 Git Bash 中输入克隆命令。

        git clone git@codeup.aliyun.com:your-company/xxx.git # 换成你复制的代码库地址

        git clone git@codeup.aliyun.com:your-company/xxx.git # 换成你复制的代码库地址

        终端会自动查找可用的公钥、私钥文件,完成和远程服务器的 SSH 连接,完成仓库克隆。

本地代码修改和推送

1. 将本地文件的改动(修改、添加、删除等),添加到 Git 索引。

例如在本地的代码库新建名为“hello.java”的文件,输入 git add 命令告诉 Git 开始追踪这个文件的版本变化。

git add hello.java

2. 创建新提交。

输入 git commit 命令将索引中记录的修改提交到代码仓库里。

git commit -m "add hello.java" # 双引号里写提交说明

3. 将本地代码仓库的改动推送至远端的代码仓库。

以推送到远端 master 分支为例,输入命令:

git push

4.验证结果。

访问目标代码库,刷新浏览器,可以看到推送记录以及与本地相同的修改内容,即新增了 hello.java 文件。

步骤三:邀请成员协作

库管理员及以上角色可以为代码库邀请成员。

  1. 网页端进入代码库,选中左侧导航栏中的成员,查看代码库成员信息。

image
  1. 库管理员点击添加成员,选择期望的用户并确定邀请。

  • 支持通过用户名搜索属于当前企业的所有成员,已加入当前库的显示被选中;

  • 若用户未加入企业,需先邀请进入企业后再添加至代码库,参见企业成员管理

  • 用户加入时可以设置加入后的成员角色:

image
  • 支持按部门添加成员,同时开启自动同步人员变更,在部门增删人员时无需在代码库手动修改人员权限:

image

步骤四:启用代码检测

开发过程中,为了更好的管理你的代码资产,Codeup 内置了代码检测服务,参见使用代码检测服务,开启后提交或合并请求的变更将自动触发扫描,并及时提供结果反馈。

imageimage

步骤五:使用代码评审

Codeup 支持多人协作的代码评审服务,功能开发完毕后,你可以发起合并请求,申请负责人评审你的代码,持续关注编码质量。

  1. 通过分支设置策略及合并请求设置自定义合并卡点规则。

  2. 创建合并请求发起代码评审。

  3. 满足合并条件后完成合并。

1-5
阿里云首页 云效 相关技术圈