langliu1216@gmail.com

Github 徽标制作 - 2022/08/31

在 Github 的很多项目中

测试覆盖率

Codecov

单元测试的测试覆盖率一直是衡量一个项目的可靠水平的重要标准,shields 中提供了多种单元测试覆盖率的平台支持,在这里我选择的是 Codecov 这个平台,因为它提供了 Github APP 可供我们在 Github 上的项目方便快捷的上传覆盖率:

教程在这里: https://docs.codecov.com/docs

使用步骤

安装 Codecov APP

https://github.com/apps/codecov

在项目中配置 Github Actions

name: API workflow

on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    name: Codecov Upload
    steps:
      - uses: actions/checkout@v3
      - name: Install requirements
        run: npm install
      - name: Run tests and collect coverage
        run: npm run test
      - name: Upload coverage reports to Codecov
        uses: codecov/codecov-action@v3

获取徽标URL

shields 中填写项目相关信息,然后会生成测试覆盖率的徽标,复制后粘贴到 README.md 文件中即可。

查看单元测试覆盖率历史

可以在 Codecov官网 查看每一次提交的测试覆盖率,网站中提供了控制台可以查看每个项目的覆盖率历史记录:

Codecov 项目控制台