robertbasic/bugreport

获取项目依赖的bug报告。

0.1.0 2017-05-24 07:36 UTC

This package is auto-updated.

Last update: 2024-09-06 09:26:23 UTC


README

Build Status Coverage Status Latest Stable Version License

获取项目依赖的bug报告。

检查GitHub仓库并报告以下内容:

  • 开放问题的数量,
  • 开放问题的平均年龄,
  • 最老开放问题的年龄,
  • 最新开放问题的年龄,
  • 开放pull请求的数量,
  • 开放pull请求的平均年龄。

当前版本是:0.1.0

这是一个PHP 7+项目。

安装

使用composer将其作为--dev依赖项安装

composer require --dev robertbasic/bugreport:0.1.0

使用方法

运行

./bin/bugreport

将在当前目录中搜索composer.lock文件并遍历项目的所有依赖项。

您也可以传递要检查的composer.lock文件的路径

./bin/bugreport /path/to/composer.lock

要检查单个依赖项,提供user/repository组合

./bin/bugreport user/repository

通过将--html作为命令行选项传递,将告诉bugreport创建一个HTML报告,而不是文本报告。

配置

默认情况下,bugreport将在当前工作目录中生成一个包含整个报告的bugreport.txt文件。您可以通过以下方式配置:

  • bugreport.json.dist复制到bugreport.json
  • bugreport.json添加到.gitignore
  • 编辑bugreport.json,将bugreport_filename的值更改为您希望保存报告的路径和文件名。

github api速率限制

如果您频繁运行bugreport或针对具有许多依赖项的项目,GitHub API速率限制可能会生效。在这种情况下,您需要创建一个GitHub个人访问令牌

bugreport需要的作用域是public_repo,没有其他。

获取令牌后,执行以下操作:

  • bugreport.json.dist复制到bugreport.json
  • bugreport.json添加到.gitignore
  • 编辑bugreport.json,将github_personal_access_token的值更改为您的令牌。

html报告

HTML报告看起来像这样

HTML bugreport

贡献

有关我们的行为准则和向我们提交pull请求的流程的详细信息,请参阅CONTRIBUTING.md

版本控制

我们使用SemVer进行版本控制。有关可用版本,请参阅此存储库的标签

变更日志

请阅读变更日志

待办事项

  • 交互式配置
  • 将报告作为html编写
  • phar用于分发
  • 项目是否已弃用?
  • 项目是否已迁移?
  • 贡献者数量(常规与偶尔)
  • 上次发布的时间
  • 过去30天的活动(打开与关闭问题/PR)
  • 从composer.json获取项目名称
  • 检查依赖的级别(1级,2级,其他)

作者

请参阅参与此项目的贡献者列表

许可

此项目采用MIT许可 - 有关详细信息,请参阅LICENSE.md文件。