Re: [Builder] github integration

[Christian Hergert <christian hergert me>]

On 01/17/2015 01:48 AM, MohanR wrote:
> I'm that guy who started a bug report to add goa provider for github
> https://bugzilla.gnome.org/show_bug.cgi?id=741684 and suggested by goa
> developers to make gnome-builder work with github, so that they can add
> the goa provider patch.

Thanks for working on that!

> I can write a GObject wrapper for github api (I have written it already
> in javascript for a simple gnome shell extension
> https://extensions.gnome.org/extension/917/gistnotes/), but I'm not
> clear about the purpose gnome-builder needs to interact with github. I
> can think of few,

I think a good place to start would be to start building a library we
can consume (GObject C would be easiest for us). And make a test program
that executes the library.

Something like:

  gh-client list-repositories
  [{name: 'gnome-builder', ...},...]

for all the operations you want to implement.

It would be preferable to have structures back rather than JSON, but we
can work with either.

> 1. github code search (https://developer.github.com/v3/search/) : search
> the code in github.

We are a ways off for code search, but we do want that eventually. I'd
be happy to have it sooner, we just need to work out the UX for how it
will integrate.

Longer term, I want this for all the code on git.gnome.org so we can
say: "Show me all uses of foo_bar_bz() in any project". This will be
helpful when documentation is lacking.

> 2. issues (https://developer.github.com/v3/issues/) : see/fix the issues from builder

This is another one that we are a ways off on. We need to design it at
the same time as the bugzilla integration (using git-bz). Since this is
GNOME, and we use bugzilla, that is going to be the first target.

I don't see why they can't share a lot of design though (with separate
implementations).

> 3. pull requests (https://developer.github.com/v3/pulls/) : handle pull requests from builder

Makes sense. Again, we need designs/mockups for how this will work. It's
also somewhat dependent on the gitg integration (where all our git work
will live).

> 4. notifications (https://developer.github.com/v3/activity/notifications/) : get instant notification from 
> github

Do you think this should be using gnome-shell notifications? Should
Builder be the application responsible for creating those notifications?

> 5. gists (https://developer.github.com/v3/gists/) : store small test code (or) use github as a personal 
> pastebin

Definitely. I'd even like to be able to selection a region of text and
then "Upload to Gist".

> I also like to know whether is this the right time to do all these changes
> or we have other idea (like writing a plugin instead of implementing in
> the base code).

I really want to avoid plugins for as long as we can. Even after
contributing to other IDEs, I'm still not sure where I want to draw the
line for plugin support.

So I'd rather just take a dependency (or statically link/embed) the
library. I want to ensure we are testing as much of the code as we can,
and plugins make testing user configurations difficult.

Cheers,

-- Christian