利用 CodeBeat 爲你在 GitHub 上的項目進行代碼質量管理

CodeBeat 是一個免費爲開源項目進行代碼質量管理的工具(付費能夠支持私有項目),目前已經支持的編程語言有 Swift、Objective-C、Go、Ruby、Python、Java、Kotlin、Javascript、Typescript、Elixir,無需對原有項目進行任何修改便可獲取針對項目的完整質量分析,方便快捷。git

前言

當咱們在 GitHub 上的代碼倉庫發生變動後,會通知 CodeBeat 執行分析操做刷新項目代碼質量評分,並在完成後刷新項目評級 / 評分的狀態或結果,如圖所示:github

代碼質量效果預覽

CodeBeat 的同類產品有 Code Climate,目前支持 Ruby、Python、PHP、JavaScript、Java、TypeScript,不過官網顯示 Swift、Go、Objective-C 的支持在計劃中,由於我是 iOS 開發,因此暫時用不了這個,在一個 Ruby 項目有試過這個,看起來還好,有興趣的同窗也能夠一試。web

本文以 EFQRCode(一個使用 Swift 做爲開發語言的二維碼庫) 爲例,簡述怎樣爲本身的開源項目添加代碼質量管理功能。編程

1. 註冊 CodeBeat 帳號

打開 codebeat.co/ 註冊一個 CodeBeat 帳號,也能夠經過 GitHub 帳戶直接登錄。CodeBeat 服務對開源項目是免費的,因此你的私有項目沒法享受到免費的持續構建服務。唔,固然,每個月支付 20 美刀成爲付費用戶後能夠解鎖無限數量私有庫的功能。編程語言

2. 從 GitHub 添加項目

登錄完成後,點擊右邊的 Add Repository 按鈕便可開始添加本身的 Git 倉庫,支持各類 Git 託管平臺,甚至自建的也能夠:工具

Add Repository

3. 開啓代碼質量管理

第一次項目導入後會當即進行一次分析,試了一下速度仍是比較快的(反正比持續集成快多了),反正個人項目導入之後刷新一下頁面就出結果了。post

唔,細心的同窗可能會發現,這一步操做完成後咱們在 GitHub 項目 Setting 中的 Webhooks 已經添加了一個屬於 codebeat.co 的 Webhook,沒錯,之後項目代碼發生更改後就會自動觸發代碼質量分析,不須要咱們手動操做了。感興趣的同窗能夠點擊 Edit 按鈕查看一下 CodeBeat 具體幹了啥:ui

Webhooks

關於 Webhook 感興趣的同窗能夠查看 GitHub 官方的資料:developer.github.com/webhooks/3d

4. 查看代碼質量分析結果

點擊進入該項目的分析結果,能夠查看到具體的問題,如代碼複雜性、代碼風格、代碼重複等,點擊 Quick Wins 這一欄能夠查看優先推薦修復的項目,以下圖所示:code

咱們能夠對應分析出的代碼質量問題對咱們的工程代碼進行修改,改完直接提交到倉庫便可,Webhook 會通知 CodeBeat 進行刷新。

沒了

在 CodeBeat 的項目設置中能夠看到更多有意思的玩法,好比將代碼質量變化通知發送到 Slack 或郵箱等,也能夠將代碼質量評級徽標添加到本身的項目 README 中,大佬們能夠自行研究...

Setting

祝操做順利,🌈


再讀一篇相似文章?

利用 Travis CI 讓你在 GitHub 上的 Xcode 項目持續構建


若有任何知識產權、版權問題或理論錯誤,還請指正。
juejin.im/post/5a3218… 轉載請註明原做者及以上信息。

相關文章
相關標籤/搜索