Upsource 代码审查工具安装及使用
Upsource 是什么
Upsource 作为一个代码审查工具, 有很多有益的特性.
- 执行高效的代码审查
- 从 IDE 审阅
- 通过浏览器跟踪重要的变化
- 发现设计缺陷, 找出项目中需要开发人员注意的部分
- 检测项目范围的风险, 分散责任
- 快速面板, 便于新成员了解项目并了解其他人的职责范围
- @回应, 讨论变化, 帮助队友
- 可与持续交付/问题跟踪/github同步
- 不用担心团队成员人数, 团队项目, 不限量~（10人免费）
- 可以自动通过邮件方式提醒成员，审查提醒
下载
安装
下载并解压到指定的文件夹
目录树
├── api
├── apps
├── backups # 备份目录
├── bin # 应用目录
├── conf # 配置文件
├── data
├── internal
├── launcher
├── lib
├── logs # 日志
├── sonarqube
└── temp # 临时文件
可用命令
命令的位置
$ ./bin/upsource.sh
# 调用 help <command> 来查看详细
configure : 配置 Upsource
start : 后台启动
run : 在当前命令行运行
status : 查看运行状态
stop : 停止
restart : 重启
rerun : 当前命令行重新运行
dump : 输出 debug info
kill : 杀死 upsource 进程
java : 管理java的路径
help <command> : 显示帮助信息
help <command name>
prints usage text for the specified command
详细文档查看
这里我们运行
$ ./bin/upsource.sh start
Starting Upsource...
* Configuring JetBrains Upsource 2019.1
* Made default base-url 'http://macbook-pro-2.local:8080/' from hostname 'macbook-pro-2.local' and listen port '8080'
* JetBrains Upsource 2019.1 runtime environment is successfully configured
* Loading logging configuration from /Users/martini/Downloads/upsource-2018.1.357/lib/ext/log4j.xml
* Redirecting JetBrains Upsource 2019.1 logging to /Users/martini/Downloads/upsource-2019.1.1644/logs/internal/services/bundleProcess
* Configuring Service-Container[bundleProcess]
* Configuring Bundle Backend Service
* Configuring Configuration Wizard
* Starting Service-Container[bundleProcess]
* Starting Bundle Backend Service
* Starting Configuration Wizard
* JetBrains Upsource 2019.1 Configuration Wizard will be available on [http://martinidemacbook-pro.local:8080?wizard_token=56mjib6C65aApME9vLl8] after start
Upsource is running
初始化配置
执行完命令后会自动打开上面显示的 http://martinidemacbook-pro.local:8080?wizard_token=56mjib6C65aApME9vLl8
选择 Set up 进行配置
这里来配置访问的地址, 如果是外网, 这里的地址应该是域名, 局域网替换成 IP, 如果是本地则可以替换成 localhost, 这里我替换为 localhost
重新配置地址
如果需要修改访问地址，可以在 命令行中重新配置（先关闭服务）
./upsource.sh configure --listen-port 8000 --base-url http://10.10.0.70:8000
创建账号密码
生成授权文件
进行安装
启动
配置代码审查项目
启动完成后会自动登录到 guest 游客账户，现在我们点击 log in 重新登录到 admin 账户
配置项目
点击右上角的六角螺母图标然后创建项目
这里以 git 作为版本控制
配置基础信息
其他两项的配置根据自己的喜好来进行, 这里不进行详细描述. 这样我们保存之后他就可以进行对项目初始化.
初始化完成后可以在项目中进行集成了.
创建用户、分配角色、分配用户组
右上角六角螺母，进入Users, 详细操作查看
设置邮件服务
设置邮件提醒
先进行上面的配置邮件服务，然后才能设置提醒
在浏览器中登录Upsource服务器，在右上角选中Upsource然后再点击右上角的账号图标选择 Notifications
在账户配置中设置开通邮件提醒，当有关于你的代码审查时会邮件通知你。
IDE 安装 upsource plugin
Settings -> 搜索 Plugin -> Browse repositories -> 搜索 upsource 安装并重启
关联项目
重启之后在设置中 Tools 中 找到UpSource UpSource , 在 Connection 菜单中填写 Server Url 为安装完成访问的地址. 点击 Test Connection 来进行填写账号密码授权, 授权成功后我们便可以在项目中使用了
在这里我们可以关联项目, 切换项目, 映射路径, 配置通知, 更改用户等信息
这样我们就可以在IDE中进行代码的review 和标识了. 这里的标识和 upsource 系统中的显示的数据是实时同步的. 并且支持 @ 某个人
使用和查看
这里的这里的快捷键是 Mac ⌃ + ⌥ + / 或 windows ctrl + alt + / , 我们选中指定的行, 填写 review 代码
填写之后就会在 IDE 行号旁边和编辑区 右上角 显示评论图标, 点击即可显示需要修改的内容, 并高亮指定的区域，还可以@具体人
同样在平台上也会存在这一项目
常规操作
更多其他操作，可以查看官方文档
