Add Events to GitHub plugin about did HOT 3 OPEN

I have looked into this a bit, and unfortunately it's more complicated than I expected so had to give up for now. However, what I've found out about events in GitHub API:

• https://github.com/AloisMahdal/events seems to be the right endpoint.
• The endpoint does not support date range querying, so returned data would have to be filtered in the plugin. (Dates returned by GitHub API are ISO 8601 in UTC zero, eg. 2016-05-24T12:32:59Z.)
• The list is limited to last 90 days/300 events, so they are not suitable for longer, eg. yearly reports.
• There are currently 25 types of events; however, I believe 2-5 should suffice (Issue comment, Commit comment, PR Review comment, maybe fork and/or create...)

from did.

There is a way to find a user's events even beyond these limits. However, we must know (1) what kind of events we are looking for, and (2) where exactly to look for them.

For instance, this request will fetch all comments on issues (including pull requests) in the psss/did repository:

• https://api.github.com/repos/psss/did/issues/comments

Pagination is fully supported (unlike with events), so one can e.g. find issue comments no. 101 by 200 (sorted by creation time):

• https://api.github.com/repos/psss/did/issues/comments?per_page=100&page=2

Similarly, commit comments can be fetched by:

• https://api.github.com/repos/psss/did/comments

This should be pull request review comments (although it is empty for this particular repository):

• https://api.github.com/repos/psss/did/pulls/comments

I have not found a way to limit the search to a specific user. That entails transferring possibly much larger data volumes, especially in the case of big repositories with many active contributors. Whether this might lead to significant performance regressions, I dare not say.

In order to make the above work, did must know which repositories to look into. This could be defined in the config file, e.g.

[github]
type = github
url = https://api.github.com/
token = <token>
repos = psss/did, sosreport/sos, scikit-learn/scikit-learn

Such a solution would happen to resolve issue #86 too.

Any thoughts on this?

from did.

Nice work!

Adding the repos = seems to me as way to go, even I kinda missed the filtering.

Regarding the performance, this is hard to say. Certainly some repos could have loads and loads of comments so the hit could be significant.

On the other hand issue/review comments are relevant (no less than eg. Bugzilla comments), and since to make this work user would have to set the repos= key, at least it won't take them by surprise and they have way to control it. Plus, there could be also another key to limit event types so that people could further optimize settings to their needs.

Seems worth trying.

from did.