umbrellio / coverspector
此软件包有助于检查代码覆盖率是否超过最低值。在持续集成或Git钩子中非常有用。
1.4.0
2020-12-22 21:21 UTC
Requires
- php: ^7.2|^7.3|^7.4|^8.0
Requires (Dev)
- php-coveralls/php-coveralls: ^2.1
- phpunit/phpunit: ^8.4|^9.0
- umbrellio/code-style-php: ^1.0
README
此软件包有助于检查代码覆盖率是否超过最低值。在持续集成或Git钩子中非常有用。
特性
- 当代码覆盖率低于最小值时,失败CI/hook。
- 打印未覆盖文件的列表
安装
运行以下命令进行安装
composer require umbrellio/coverspector
用法
允许覆盖率工具打印关于未覆盖文件的详细信息。对于phpunit,请将其添加到phpunit配置中
addUncoveredFilesFromWhitelist="true"
对于codeception
show_uncovered: true
在您的CI中,将覆盖率输出导出到文件中
vendor/bin/codecept run --coverage | tee coverage.txt
然后,使用最小代码覆盖率值运行coverspector
vendor/bin/coverspector --file=coverage.txt --min=100
如果覆盖率低于要求,coverspector将使作业失败,并打印所有未完全覆盖的文件的列表
CI覆盖率工件
如果您仍然希望将覆盖率报告保存为CI工件,您应该在CI配置中设置
when: on_failure
。
许可
在MIT许可证下发布。
作者
由Makin Vladislav创建。
贡献
- 分支(https://github.com/umbrellio/coverspector)
- 创建您的功能分支(
git checkout -b feature/my-new-feature
) - 提交您的更改(
git commit -am '添加一些功能'
) - 将更改推送到分支(
git push origin feature/my-new-feature
) - 创建新的Pull Request