prestashop / traces
A simple CLI tool to generate information about GitHub contributors of a repository
Installs: 3 847
Dependents: 0
Suggesters: 0
Security: 0
Stars: 7
Watchers: 10
Forks: 12
Open Issues: 3
Type:project
Requires
- ext-json: *
- cache/filesystem-adapter: ^1.2
- knplabs/github-api: ^3.14
- nyholm/psr7: ^1.8
- symfony/console: ^7.1
- symfony/dotenv: ^7.1
- symfony/http-client: ^7.1
- symfony/yaml: ^7.3
Requires (Dev)
- phpstan/phpstan: ^2.1
- dev-master
- v6.1.0
- v6.0.1
- v6.0.0
- v5.2.5
- v5.2.4
- v5.2.3
- v5.2.2
- v5.2.1
- v5.2.0
- v5.1.0
- v5.0.0
- v4.0.0
- v3.0.0
- v2.0.1
- v2.0.0
- v1.1.1
- v1.1.0
- v1.0.5
- v1.0.4
- v1.0.3
- v1.0.2
- v1.0.1
- v1.0
- dev-topCompanies
- dev-dependabot/composer/symfony/console-7.3.1
- dev-dependabot/composer/symfony/yaml-7.3.1
- dev-dependabot/composer/symfony/http-client-7.3.1
- dev-githubActions
This package is auto-updated.
Last update: 2025-07-02 12:54:03 UTC
README
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
The authentication use a Github Token.
Note: You can fetch here : https://github.com/settings/tokens/new?description=traces&scopes=repo,read:org
$ composer require prestashop/traces # Fetch all repositories $ php bin/console traces:fetch:repositories --ghtoken=<ghtoken> OR $ GH_TOKEN=<ghtoken> php bin/console traces:fetch:repositories OR * Add GH_TOKEN=<ghtoken> in .env file $ php bin/console traces:fetch:repositories ## A file gh_repositories.json is generated # Check a repository $ php bin/console traces:fetch:contributors --ghtoken=<ghtoken> -r <repositoryName> --config="config.yml" OR $ GH_TOKEN=<ghtoken> php bin/console traces:fetch:contributors -r <repositoryName> --config="config.yml" OR * Add GH_TOKEN=<ghtoken> in .env file $ php bin/console traces:fetch:contributors -r <repositoryName> --config="config.yml" ## A file contributors.js is generated # Fetch all merged pullrequests $ php bin/console traces:fetch:pullrequests:merged --ghtoken=<ghtoken> OR $ GH_TOKEN=<ghtoken> php bin/console traces:fetch:pullrequests:merged OR * Add GH_TOKEN=<ghtoken> in .env file $ php bin/console traces:fetch:pullrequests:merged ## A file gh_pullrequests.json is 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.