https://github.com/prestashop/traces
Micro CLI application to get all GitHub contributors for a specified repository
https://github.com/prestashop/traces
github github-api hacktoberfest php tools
Last synced: 3 months ago
JSON representation
Micro CLI application to get all GitHub contributors for a specified repository
- Host: GitHub
- URL: https://github.com/prestashop/traces
- Owner: PrestaShop
- License: mit
- Created: 2016-12-02T13:49:19.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-05-23T07:13:33.000Z (over 1 year ago)
- Last Synced: 2024-10-29T17:04:06.437Z (about 1 year ago)
- Topics: github, github-api, hacktoberfest, php, tools
- Language: PHP
- Homepage:
- Size: 90.8 KB
- Stars: 7
- Watchers: 11
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Traces
Traces is a Symfony CLI application that is able to :
* fetch all repositories of the PrestaShop organization
* fetch all contributors and their contributions in "developer-readable" JSON format for a specified repository
* fetch all merged pull requests of the PrestaShop organization
## Installation / usage
The authentication use a Github Token.
> Note: You can fetch here : https://github.com/settings/tokens/new?description=traces&scopes=repo,read:org
```bash
$ composer create-project prestashop/traces
```
All the following commands require a Github token to access and use Github APIs, you have three ways to define this token:
- using the command option: `--ghtoken=`
- using an environment variable: GH_TOKEN= php bin/console `
- using .env file and adding GH_TOKEN=
```bash
# 1- Fetch all repositories
$ php bin/console traces:fetch:repositories
## A file gh_repositories.json is generated
# 2- Check a repository (the repository option is optional and will then fetch ALL repositories from gh_repositories.json)
$ php bin/console traces:fetch:contributors -r --config="config.yml"
## A file contributors.json is generated
# 3- Fetch all merged pullrequests
$ php bin/console traces:fetch:pullrequests:merged
## A file gh_pullrequests.json is generated
# 4- Fetch new contributors
$ php bin/console traces:generate:newcontributors --config="config.yml"
## A file newcontributors.json is generated
# 5- Fetch top companies
$ php bin/console traces:generate:topcompanies --config="config.yml"
## Files topcompanies.json and gh_loginsWOCompany.json are generated
```
## Configuring
There are a number of settings that can be configured via the config file. Take a look at the `config.dist.yml` file for an example.
Option | Description
-------------------|-------------------------------------------------------------------------------------------
exclusions | List of excluded users.
keepExcludedUsers | Set to `true` to flag excluded contributors instead of filtering them out from the output.
fieldsWhitelist | List of fields to keep from the API result. Leave blank if you want to keep them all.
extractEmailDomain | Set to `true` to extract the user's email domain and include it in the generated file
## License
This project is released under the MIT license.