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

image-20200514094730342

選擇 Set up 進行配置

image-20200514095302507

這里來配置訪問的地址, 如果是外網, 這里的地址應該是域名, 局域網替換成 IP, 如果是本地則可以替換成 localhost, 這里我替換為 localhost

重新配置地址

如果需要修改訪問地址,可以在 命令行中重新配置(先關閉服務)

./upsource.sh configure --listen-port 8000 --base-url http://10.10.0.70:8000

創建賬號密碼

image-20200514095507219

生成授權文件

image-20200514095556473

進行安裝

image-20200514095755576

啟動

image-20200514095834245

配置代碼審查項目

啟動完成后會自動登錄到 guest 游客賬戶,現在我們點擊 log in 重新登錄到 admin 賬戶

image-20200514100802763

image-20200514100928347

image-20200514100948784

配置項目

點擊右上角的六角螺母圖標然后創建項目

image-20200514101431318

這里以 git 作為版本控制

配置基礎信息

image-20200514102536456

image-20200514103019331

其他兩項的配置根據自己的喜好來進行, 這里不進行詳細描述. 這樣我們保存之后他就可以進行對項目初始化.

初始化完成后可以在項目中進行集成了.

image-20200514103243977

創建用戶、分配角色、分配用戶組

右上角六角螺母,進入Users, 詳細操作查看

image-20200527120049713

設置郵件服務

image-20200514194305753

image-20200514195304264

設置郵件提醒

先進行上面的配置郵件服務,然后才能設置提醒

在瀏覽器中登錄Upsource服務器,在右上角選中Upsource然后再點擊右上角的賬號圖標選擇 Notifications

image-20200514111923621

image-20200514111901806

在賬戶配置中設置開通郵件提醒,當有關於你的代碼審查時會郵件通知你。

image-20200514194217648

IDE 安裝 upsource plugin

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

關聯項目

重啟之后在設置中 Tools 中 找到UpSource UpSource , 在 Connection 菜單中填寫 Server Url 為安裝完成訪問的地址. 點擊 Test Connection 來進行填寫賬號密碼授權, 授權成功后我們便可以在項目中使用了

image-20200519180921470

在這里我們可以關聯項目, 切換項目, 映射路徑, 配置通知, 更改用戶等信息

image-20200519181054434

這樣我們就可以在IDE中進行代碼的review 和標識了. 這里的標識和 upsource 系統中的顯示的數據是實時同步的. 並且支持 @ 某個人

使用和查看

這里的這里的快捷鍵是 Mac ⌃ + ⌥ + / 或 windows ctrl + alt + / , 我們選中指定的行, 填寫 review 代碼

image-20200519181842174

填寫之后就會在 IDE 行號旁邊和編輯區 右上角 顯示評論圖標, 點擊即可顯示需要修改的內容, 並高亮指定的區域,還可以@具體人

image-20200519182305245

同樣在平台上也會存在這一項目

image-20200519182458934

常規操作

image-20200527113717220

更多其他操作,可以查看官方文檔


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM