crowphp/badger

用于生成覆盖率徽章的命令行工具

0.3 2021-01-28 04:07 UTC

This package is auto-updated.

Last update: 2024-08-28 16:40:28 UTC


README

Badger 是一个小的 CLI 工具,用于从 clover.xml 报告生成 shields.io 兼容的 JSON,并将其上传到 badger-server,有关服务器更多信息请查看 github.com/crowphp/badger-server。

使用 composer 安装 badger

composer require --dev crowphp/badger:dev-master

注意:目前 badger 正在开发中,请谨慎使用。

用法

帮助文档

$ php vendor/bin/badger --help
Console Tool

Usage:
  command [options] [arguments]

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
  help             Displays help for a command
  list             Lists commands
 upload
  upload:coverage  Creates json for coverage badge shields.io and uploads it to a given badger server

在 badger 服务器上为指定的分支创建徽章模式

$ php upload:coverage <server> <branch> <secret-key>

Description:
  Creates json for coverage badge shields.io and uploads it to a given badger server

Usage:
  upload:coverage <server> <branch> <secret-key>

Arguments:
  server                URL for Badger Server
  branch                The branch name for the coverage
  secret-key            Secret api key for badger server

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug