Upsource 一個新的代碼審查工具(Polyglot code review tool),Upsource安裝、配置及使用介紹……
<!--more-->
寫在前面的話
最近因項目組需要,在尋找一款比較好用的代碼審查工具,因為是Intellj IDEA深度粉絲,所以優先找的還是能支持Intellij IDEA的工具,正好在JetBrains官網上看到這款Upsource工具,於是打算花了一周時間研究下,於是各種baidu,Google找資料,發現這款工具的中文介紹少之又少,所有就有了這篇文章,此文僅供需要的同仁,如有問題歡迎指正。
- 另外在網上也找到17款最佳的代碼審查工具,供大家參考。
安裝與配置
下載解壓
下載合適版本的Upsource安裝程序點擊下載,我用的版本為Upsource-3.5.3550,將其解壓到任意磁盤,進入Upsource根目錄(下面統稱upsource_home
),准備進行安裝,
Win下啟動安裝配置
- Upsource對比較耗內存,建議機器內存在4G以上
- 在Windows環境,為了避免碰到各種奇奇怪怪的問題,最好關閉所有殺毒軟件
啟動安裝過程非常簡單,
- 運行Upsource作為后台進程進行安裝 以管理員身份運行打開cmd,切換到<upsource_home>目錄,執行命令
upsource_home\bin\upsource.bat start
如圖
停止upsource服務命令:upsource.bat stop
2.運行Upsource作為Windows Service
upsource_home\bin\upsource.bat service install /runAsSystem
啟動完成后會打開默認瀏覽器網址http://機器名:80/welcome 頁面,注意在3.5版本中windows默認端口為80,在以前的版本端口默認是8080。這是你會看到如下頁面: 點擊
Set up
進行安裝,這時我們可以修改訪問域名和端口 點擊
Next
進入用戶管理,設置管理員用戶名密碼 點擊
Next
,這里會提示免費版支持10個免費用戶,如果你有License Key的話,在這里可以輸入。 點擊
Finish
,靜候安裝 啟動完成后,會默認打開歡迎頁面,到這步安裝大功告成。
創建/管理項目
使用admin賬戶登錄,點擊Create Project
創建項目 點擊
Create project
完成項目創建,接下來就等待代碼clone完成。
設置用戶/組/角色權限
代碼下載完成之后,就開始設置用戶權限 點擊
Users
進行用戶/組/角色權限設置,Upsource安裝完成之后默認添加了admin和guest用戶。 設置用戶時可以指定用戶組,每個項目有三個用戶組,分別為
Code Viewers
、Developers
、Project Admin
。同一個用戶可以擁有多個用戶組。 角色權限可以設置全局角色和對應某個項目的角色,總共有五種,分別是:
Code Viewer
、Developer
、Observer
、Project Admin
、System Admin
,每個角色所擁有的權限都可以根據自己需求靈活進行配置 這里我們為
cms
項目添加兩個用戶:Lucy
為Project Admin
角色,tom
為Developer
角色
代碼審查(Code Review)
Upsource能為代碼審查提供哪些便利
- 對多種類型的代碼庫與軟件開發語言進行代碼瀏覽
- 對同一個代碼庫的多個修訂版本進行瀏覽,並且通過一個圖形化工具顯示多個修訂版本之間的關系
- 對代碼變更進行跟蹤,包括提交歷史、變更差異比較,以及分支與合並的操作
- 對團隊的代碼進行審查,包括代碼的討論、跟蹤代碼評論以及最終的結論
如何進行代碼審查
當開發者tom
提交完代碼之后,項目管理員Lucy
登錄到Upsource,可以看到所有項目的索引,每個項目都有對應一個特定的VCS倉庫。
單擊項目名稱列出每一次提交的版本,每一次提交的代碼羅列,這里你可以瀏覽代碼,創建代碼審核,分支列表,分支與分支代碼比較,代碼提交代碼審核分析(可視化圖表)……等等你想要的功能。
拖動滾動條,將光標移動到需要進行審核的修訂版本上,點擊
Create review
創建一次新的代碼審查
代碼對比
點擊左邊修訂版中提交的文件名顯示嵌入差異: 點擊
Side-by-side diff
可以查看整個文件在提交前后的變化
關於代碼評論
無論你是作為一個author
、reviewer
或watcher
,你都可以發表評論,發表的評論所有參與的人都可以看得見 有三種類型的評論:
- 審查意見:這種類型的評論是不是捆綁到任何代碼特定文件或部分。
- 行級評論:這種類型的注釋與特定的代碼行相關聯。
- 代碼塊評論:這種類型的評論是為了找出一個特定的代碼片段中的一個文件進行審查。
行級評論
代碼塊評論
參與評論
Lucy
進行評論后,開發者tom
會收到郵件通知,登錄tom
賬戶,可以清晰的看到Lucy
的評論的代碼,可以進行回復。 當點擊
Accept
時,表示接受此次修訂,此次審查被視為完成。
Upsource分析功能
Upsource提供了例如代碼提交分析、代碼審查分析等功能。
其他
JetBrains提供的Upsource授權計划是根據用戶的數量所決定的,不超過10人(去掉admin、guest其實就只有8個用戶)的團隊可以免費使用。同樣,教育機構及非盈利的開源項目也可以免費使用。