Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fetch contributors from an organization #4

Merged
merged 3 commits into from May 11, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
@@ -1,5 +1,4 @@
contributors.js
config.yml
composer.lock
/vendor/
.idea/
13 changes: 8 additions & 5 deletions README.md
@@ -1,21 +1,24 @@
# Traces

Traces is a micro CLI application that is able to get all contributors and their contributions in
"developer-readable" JSON format for a specified repository.
Traces is a micro CLI application that is able to get all contributors and their contributions in "developer-readable" JSON format for a specified repository.


## Installation

The authentication is a basic login/password for GitHub.

> Note: If your Github login uses two-factor authentication, use an API token instead of password

```bash
$ composer require prestashop/traces

$ ./vendor/bin/traces <repositoryOwner/repositoryName> <login> <password> --config="config.yml"
# Check a repository
$ ./vendor/bin/traces <login> <password> -o <repositoryOwner/repositoryName> --config="config.yml"

# Check an organization
$ ./vendor/bin/traces <login> <password> -r <repositoryOwner> --config="config.yml"
```

> Note: If your Github login uses two-factor authentication, use an API token instead of password

A file named ``contributors.js`` will be generated, you can manipulate it using any programming language.

## Configuring
Expand Down
3 changes: 2 additions & 1 deletion composer.json
Expand Up @@ -6,7 +6,8 @@
"symfony/console": "v3.2.0",
"symfony/filesystem": "v3.2.0",
"symfony/yaml": "v3.2.0",
"guzzlehttp/guzzle": "~6.0"
"guzzlehttp/guzzle": "~6.0",
"ext-json": "*"
},
"license": "MIT",
"authors": [
Expand Down