robertbasic/bugreport

Get a bug report on a project's dependencies.

bugreport

, _(*1)

Get a bug report on a project's dependencies., _(*2)

Looks at a GitHub repository and reports on:, _(*3)

• number of open issues,
• average age of open issues,
• age of oldest open issue,
• age of newest open issue,
• number of open pull requests,
• average age of open pull requests.

Current version is: 0.1.0, _(*4)

This is a PHP 7+ project., _(*5)

installation

Install it with composer as a --dev dependency:, _(*6)

composer require --dev robertbasic/bugreport:0.1.0

usage

Running:, _(*7)

./bin/bugreport

will search for a composer.lock file in the current directory and go through all the dependencies of the project., _(*8)

You can also pass a path to the composer.lock file you want to check:, _(*9)

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

To check for a single dependency, provide a user/repository combination:, _(*10)

./bin/bugreport user/repository

Passing in --html as a command line option, will tell bugreport to create an HTML report, instead of a text one., _(*11)

configuration

By default bugreport will generate a bugreport.txt file in the current working directory with the entire report. You can configure that by:, _(*12)

• copy bugreport.json.dist to bugreport.json
• add bugreport.json to .gitignore
• edit bugreport.json, change the value of bugreport_filename to the path and filename where you want the report to be saved.

github api rate limit

If you run bugreport too much, or against a project with lots of dependencies, the github api rate limit might kick in. In that case, you need to create a GitHub personal access token., _(*13)

The ONLY scope bugreport requires is public_repo, nothing else., _(*14)

Once you have the token do the following:, _(*15)

• copy bugreport.json.dist to bugreport.json
• add bugreport.json to .gitignore
• edit bugreport.json, change the value ofgithub_personal_access_token to your token.

html report

The HTML report looks something like this:, _(*16)

, _(*17)

contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us., _(*18)

versioning

We use SemVer for versioning. For the versions available, see the tags on this repository., _(*19)

changelog

Please read the changelog., _(*20)

todo

• [ ] interactive configuration
• [x] write report as html
• [ ] phar for distribution
• [ ] is the project deprecated?
• [ ] did the project move?
• [ ] number of contributors (regular vs. occasional)
• [ ] age of last release
• [ ] activity in the last 30 days (opened vs. closed issues/PRs)
• [ ] get project name from composer.json
• [ ] level of dependency to check (1st, 2nd, other)

authors

• Robert Basic - robertbasic

See also the list of contributors who participated in this project., _(*21)

license

This project is licensed under the MIT License - see the LICENSE.md file for details., _(*22)