OwnerType: add OwnerBot

[domenkozar]

See https://developer.github.com/v4/object/bot/

[TomMD]

I'm very confused. The link is for github api v4 but this library is supporting v3. Is there a shift to support v4? Did I miss the concept of 'bot' defined in the v3 API? I suppose it is just unspecified but should appear somewhere like https://developer.github.com/v3/users/

[phadej]

v4 is GraphQL api, which we cannot really support with current design of library.

[domenkozar]

This also appears on v3, but unfortunately there's not a single word mentioning it.

See type in https://api.github.com/users/bors[bot]

[domenkozar]

@phadej @TomMD does that clear up confusion?

[phadej]

It does clear some confusion, but makes me wonder whether v3 stuff works by accident. Could you contact GitHub support and clarify (perfectly resulting into updated v3 documentation).

I said it before, and I repeat, tracking GitHub undocumented features is not worth anything. There should an URL to refer. And this library works with v3 API.

[domenkozar]

@phadej it's part of github apps (which we still need to PR).

But even without other parts of the github apps API, if someone has github app configured, they can use bots to trigger webhooks that will error out in the current github.

See https://developer.github.com/apps/differences-between-apps/#machine-vs-bot-accounts

[domenkozar]

github apps are part of v3

[robbiemcmichael]

GitHub Apps are still an API preview. There's been some previous discussion where there's been apprehension about incorporating API previews into this library in #351 and #367.

I started work on a separate library for API previews but haven't had any time to work on it recently. You're welcome to contribute or use that code for inspiration. I might try to clean up some of it this weekend. You'll probably also find #365 and #370 relevant for authenticating as a GitHub App.

[robbiemcmichael]

Looking at this a bit more closely, it does look like the Bot user type has made its way into a few different parts of the v3 API. Here's another example where .merged_by.type is Bot. It looks like we're getting lucky on this occasion because SimpleUser doesn't have a type field otherwise this library would fail to decode some pull requests.

Since it looks like the Bot type is here to stay in the v3 API, it seems like a good idea to make this change otherwise we'll eventually end up with users raising issues because they're getting Unknown OwnerType errors.

[phadej]

I'd still check it's not an OwnerOrganisation.

[phadej]

Ok. I think this change is unavoidable. I'll improve the haddocks fo OwnerType after this is merged, yet there's one small issue in the code.

[domenkozar]

@phadej fixed