arueckauer/package-info

验证GitHub组织composer包的需求


README

验证GitHub组织composer包的需求

安装

克隆仓库并安装依赖项。

git clone git@github.com:arueckauer/package-info.git
cd package-info
composer i

配置

该应用程序附带针对各种PHP框架组织的示例配置。将其中一个config\autoload\local-*.dist文件复制到config\autoload\local.php。或者,您可以根据任何示例配置创建自己的配置。

将您的个人访问令牌放入github_api_token并提供一个cache_file_path

配置选项

  • github_api_token 您的个人访问令牌(请参阅GitHub / 设置 / 开发者设置
  • organizations 将要检查其仓库的组织名称数组。
  • ignore_repositories 将要忽略并因此不检查的包名称数组。
  • ignore_branches 将要忽略并因此不检查的分支名称数组。
  • cache_file_path 缓存路径的位置。

命令

有三个可用命令。

构建缓存

这是第一步。为了不反复从GitHub获取所有信息,包信息被缓存。要构建缓存,请执行以下命令。根据组织的大小,这可能需要一些时间。

php bin/console cache:build

显示单个包的信息

此命令显示单个包的可用头(分支、版本和拉取请求)等信息。

php bin/console get <package-name>

检查需求

检查命令对给定需求执行实际检查。

示例

要检查哪些仓库支持PHP 8.1,请运行以下命令。

php bin/console check check -r php:^8.1

上一个命令的结果包括分支和拉取请求。要仅检查版本,请运行以下命令。

php bin/console check check -r php:^8.1 -t release

要仅包括特定组织的仓库,请运行以下命令。

php bin/console check check -r php:^8.1 -vendor mezzio

要获取完整的选项列表,请执行以下命令。

php bin/console help check