Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arueckauer/package-info
Verifying composer packages requirements of GitHub organizations
https://github.com/arueckauer/package-info
composer github github-api
Last synced: 2 months ago
JSON representation
Verifying composer packages requirements of GitHub organizations
- Host: GitHub
- URL: https://github.com/arueckauer/package-info
- Owner: arueckauer
- License: bsd-3-clause
- Created: 2020-06-04T20:15:46.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-11T22:42:48.000Z (3 months ago)
- Last Synced: 2024-10-11T23:15:14.353Z (3 months ago)
- Topics: composer, github, github-api
- Language: PHP
- Homepage:
- Size: 193 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# package-info
Verifying requirements of composer packages of a GitHub organization
## Installation
Clone the repository and install dependencies.
```bash
git clone [email protected]:arueckauer/package-info.git
cd package-info
composer i
```
## Configuration
The application comes with sample configurations for various PHP framework organizations. Copy one of the `config\autoload\local-*.dist` files to `config\autoload\local.php` . Or alternatively create your own configuration based on any of the sample configurations.
Place your personal access token in `github_api_token` and provide a `cache_file_path`.
### Configuration options
- `github_api_token` Your personal access tokens (see GitHub / Settings / [Developer settings](https://github.com/settings/tokens))
- `organizations` An array of organization names whose repositories will be checked.
- `ignore_repositories` An array of package names, that will be ignored and thus not checked.
- `ignore_branches` An array of branch names, that will be ignored and thus not checked.
- `cache_file_path` Location of the cache path.
## Commands
There are three commands available.
### Build cache
This will be the first step. To not repeatedly fetch all information from GitHub, package information is cached. To build the cache, execute the following command. Depending on the size of the organization, this may take a while.
```bash
php bin/console cache:build
```
### Show information for a single package
This command shows information such as available heads (branches, releases and pull requests) for a single package.
```bash
php bin/console get
```
### Check requirements
The check command performs the actual check against given requirements.
Examples:
To check which repositories are supporting PHP 8.1, run the following command.
```bash
php bin/console check -r php:^8.1
```
The results of the previous command include branches and pull requests. To check only releases, run the following command.
```bash
php bin/console check -r php:^8.1 -t release
```
To include only repositories of a specific organization, run the following command.
```bash
php bin/console check -r php:^8.1 -vendor mezzio
```
For a complete list of options, execute the following command.
```bash
php bin/console help check
```