使用 Upsource 實現代碼審查 - jetbrains 系列

安裝

Upsource 是什麼

Upsource 做爲一個代碼審查工具, 有不少有益的特性.

• 執行高效的代碼審查
• 從 IDE 審閱
• 經過瀏覽器跟蹤重要的變化
• 發現設計缺陷, 找出項目中須要開發人員注意的部分
• 檢測項目範圍的風險, 分散責任
• 快速麪板, 便於新成員瞭解項目並瞭解其餘人的職責範圍
• @迴應, 討論變化, 幫助隊友
• 可與持續交付/問題跟蹤/github同步
• 不用擔憂團隊成員人數, 團隊項目, 不限量~

下載

下載

安裝

下載並解壓到指定的文件夾

目錄樹

├── 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 2018.1
* Made default base-url 'http://macbook-pro-2.local:8080/' from hostname 'macbook-pro-2.local' and listen port '8080'
* JetBrains Upsource 2018.1 runtime environment is successfully configured
* Loading logging configuration from /Users/duoli/Downloads/upsource-2018.1.357/lib/ext/log4j.xml
* Redirecting JetBrains Upsource 2018.1 logging to /Users/duoli/Downloads/upsource-2018.1.357/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 2018.1 Configuration Wizard will be available on [http://macbook-pro.local:8080?wizard_token=UwxfxNH1OxGS75l3DO9p] after start
Upsource is running
複製代碼

配置項目

根據在命令行顯示的信息, 咱們打開這個地址 http://macbook-pro.local:8080?wizard_token=UwxfxNH1OxGS75l3DO9p, 若是在服務器上

這裏咱們點擊 Set Up 來進行安裝

這裏來配置訪問的地址, 若是是外網, 這裏的地址應該是域名, 局域網替換成 IP, 若是是本地則能夠替換成 localhost, 這裏我替換爲 localhost

建立帳號密碼

生成受權文件

進行安裝

開始啓動, 啓動完成就能夠登陸了

在 phpstorm/jetbrains 系列中集成

這裏我只是在phpstorm 中進行測試的, 可是是支持全系的, 只不過對代碼部分的支持可能不太完善

配置代碼審查項目

這裏以 git 做爲版本控制

配置基礎信息

配置代碼集成

其餘兩項的配置根據本身的喜愛來進行, 這裏不進行詳細描述. 這樣咱們保存以後他就能夠進行對項目初始化.

初始化完成後能夠在項目中進行集成了.

安裝 upsource plugin

Settings -> 搜索 Plugin -> Browse repositories -> 搜索 upsource 安裝並重啓

關聯項目

重啓以後在設置中搜索 UpSource , 在 Connection 菜單中填寫 Server Url 爲安裝完成訪問的根目錄. 點擊 Test Connection 來進行填寫帳號密碼受權, 受權成功後咱們即可以在項目中使用了

設置完成後在右下角有個標識表明已經啓動了 Upsource 服務

在這裏咱們能夠關聯項目, 切換項目, 映射路徑, 配置通知, 更改用戶等信息

這樣咱們就能夠在IDE中進行代碼的review 和標識了. 這裏的標識和 upsource 系統中的顯示的數據是實時同步的. 而且支持 @ 某我的.

使用和查看

這裏的這裏的快捷鍵是 ctrl + alt + /, 咱們選中指定的行, 填寫 review 代碼

填寫以後就會在 IDE 行號旁邊和編輯區 右上角 顯示評論圖標, 點擊便可顯示須要修改的內容, 並高亮指定的區域

一樣在平臺上也會存在這一項目

這裏有幾個技巧

支持 @ 來指定人

支持標籤標註

好了, 團隊中開始試用..

其餘

錯誤 : 沒法將數據保存到數據庫

Updating project : An error occurred during flushing data to database upsource

這裏內存必須在 8G 以上, 不然會報上面的錯誤.

錯誤 : 用戶沒有看到這個項目

通常來說就是沒有把這個用戶添加到所屬項目中.

參考文章

• 如何使代碼審查更高效

特性 : 支持自定義標籤

這些標籤能夠同步到 IDE 中.

特性 : 多用戶帳戶能夠歸到一個用戶下進行管理

好比一個用戶有多個git global標識, 多是不一樣時期的用戶的暱稱, 這裏能夠識別爲一個帳戶, 更方便進行管理