Skip to content
New issue

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

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

Already on GitHub? # to your account

Option to provide list of repositories via a configuration file #5

Open
mxmehl opened this issue Aug 16, 2023 · 2 comments
Open

Option to provide list of repositories via a configuration file #5

mxmehl opened this issue Aug 16, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@mxmehl
Copy link
Collaborator

mxmehl commented Aug 16, 2023

To get a better overview about a set of repositories we need a way to specify multiple repositories. I would suggest an option -f, --file, which takes the name of a configuration file which contains all the information needed to do the analysis. This would be the expression for filtering by author email and a list of repository URLs.

To make this efficient, we might want to cache repositories at a defined location, so that the tool only transfers the minimal amount of data and doesn't check out all repositories from scratch with every invocation (see #4).

The report should then show a summary instead of the results for an individual repository.

@hedtke hedtke added the enhancement New feature or request label Aug 16, 2023
@mxmehl
Copy link
Collaborator Author

mxmehl commented Aug 17, 2023

I wonder what the summary for a multi-repo check should look like. Wouldn't it be better to just print all reports as a list of dicts, and also wrap the output for a single repo in a list? This way, it could easily be analysed by subsequent steps or tools.

@cornelius
Copy link

For a summary I would expect a report like this:

Repository Number of ORG contributors Total ORG contributions Latest contribution
https://github.com/example/one 3 47 2023-08-01
https://github.com/example/two 1 2 2018-12-24 (more than a year ago)
https://github.com/example/three 0 0 no contributions

Where "ORG" would be a label or title for the specific contributions the checker filtered for.

I would maybe also like to see some additional fields such as "percentage of ORG contributions" or "average ORG activity per week" or "average total activity per week".

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants