快速在GitHub搭建一個規範的開源項目(四)

前三篇博客
快速在GitHub搭建一個規範的開源項目(一)
快速在GitHub搭建一個規範的開源項目(二)
快速在GitHub搭建一個規範的開源項目(三)
我們已經介紹瞭如何初始一個團隊並且制定了規範的開發流程和代碼提交流程,Issue規範以及接入CI。
接下來我們介紹如何統計項目的單側覆蓋率。
這裏我們用到的工具是codecov。官網鏈接
在這裏插入圖片描述
其他集成非常簡單,只要登錄官網,然後關聯GitHub賬號。(這裏有一點要注意,記得先清理一下cookie中的緩存。否則很難登錄上去,這個bug官方後續應該會處理掉。),在我們項目的.travis.yml文件中增加下面👇這一行腳本即可完成集成。
bash <(curl -s https://codecov.io/bash)
完整的.travis.yml文件如下

language: java
sudo: false # faster builds

jdk:
  - openjdk8

cache:
  directories:
    - $HOME/.m2
## 不需要安裝任何其他腳本
install: true

script:
  - travis_wait 30 ./mvnw --batch-mode clean install -DskipTests=false  -Dmaven.javadoc.skip=true

after_success:
  - bash <(curl -s https://codecov.io/bash)

after_failure:
  - echo "build failed!"

後續我們提交PR後,項目自動在Travis-CI跑單測,單測跑完後會將單測報告發送到codecov。
codecov配置教程
這是我們項目的配置教程,大家可以參考一下。
在項目根目錄創建.codecov.yml文件,文件內容如下:

coverage:
  status:
    #僅僅統計pull request
    patch:
      default:
        ## 必須滿足的最低覆蓋率才能被視爲success
        target: 70%
        ## 最多允許覆蓋率下降0.1%,才能視爲success
        threshold: 0.1%
  ## 單測覆蓋率在此範圍內會變綠
  range:
    50..100
## 忽略的文件
ignore:
  - "src/main/java/com.xy.datasource.spring.boot.starter.annotation/.*"

其他定製化的需求可以參考官網教程,集成後的效果如下
在這裏插入圖片描述
圖標在此目錄下,複製到README.md文件即可。
在這裏插入圖片描述
集成後有PR提交時,在GitHub的PR界面都會出現這些檢測
在這裏插入圖片描述
最後我們來講一下如何將單測分析報告提交到GitHub評論區,打開codecov,然後在選擇你的頭像,點擊Account,然後選中右邊的Yaml。添加下面這一項配置即可,這樣配置是對所有repository有效,如果你想針對某個工程單獨配置,可以在.codecov.yml文件中修改配置即可。
在這裏插入圖片描述
配置我單獨貼出來,方便大家複製

comment:
  layout: "reach, diff, flags, files"
  behavior: default
  require_changes: false  # if true: only post the comment if coverage changes
  require_base: no        # [yes :: must have a base report to post]
  require_head: yes       # [yes :: must have a head report to post]
  branches:               # branch names that can post comment
    - "!*-dev"

接下來打開GitHub提交PR,我們就可以在評論區看到下面這個效果了
在這裏插入圖片描述
下一篇我們講一下代碼的發佈流程。傳送門👇👇👇
快速在GitHub搭建一個規範的開源項目(五)

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章