[Announce] A GitHub Issues interface for Org-mode

[Announce] A GitHub Issues interface for Org-mode

[Puneeth Chaganti]

Hello Orgsters,

Issue Tracker integration with Org-mode has been something that a lot
of people have been looking for. Being the GitHub addict, that I am, I
decided to hack up something that integrates GitHub issues with
Org-mode.

It presently allows
- Importing all open issues from a project into an org-file. [Milestone
  due dates (if any) are added as Deadlines.
- Closing Issues, Editing Tags, Changing Issue Name
- Convert a TODO item into an Org-mode issue.

However, it uses APIv3 of GitHub, which is Beta. So, expect some
erratic behaviour. :)

I have put up my code here [1]. The code isn't all that clean and
robust, but it works. Hope atleast some of you will find it useful.
Any suggestions, feedback and code help is more than welcome.

Thanks,
Puneeth

[1] https://github.com/punchagan/org-ghi

Re: [Announce] A GitHub Issues interface for Org-mode

[William Henney]

Dear Puneeth

On Tue, May 24, 2011 at 11:40 PM, Puneeth Chaganti <punchagan@gmail.com> wrote:
> Issue Tracker integration with Org-mode has been something that a lot
> of people have been looking for. Being the GitHub addict, that I am, I
> decided to hack up something that integrates GitHub issues with
> Org-mode.
>

This looks very promising - thanks! It is a shame though that the body
of the issue and the comments don't get synched (I see that you have
these listed as TODO). I also noticed that if I type any text directly
under the issue's heading in my org file, then this text is /wiped/
when I execute =org-ghi-update-current-issue=. However, any
subheadings (and their text) do survive, but they never get synched
back to GitHub.

Cheers

Will

> It presently allows
> - Importing all open issues from a project into an org-file. [Milestone
>  due dates (if any) are added as Deadlines.
> - Closing Issues, Editing Tags, Changing Issue Name
> - Convert a TODO item into an Org-mode issue.
>
> However, it uses APIv3 of GitHub, which is Beta. So, expect some
> erratic behaviour. :)
>
> I have put up my code here [1]. The code isn't all that clean and
> robust, but it works. Hope atleast some of you will find it useful.
> Any suggestions, feedback and code help is more than welcome.
>



-- 

  Dr William Henney, Centro de Radioastronomía y Astrofísica,
  Universidad Nacional Autónoma de México, Campus Morelia

Re: [Announce] A GitHub Issues interface for Org-mode

[Puneeth Chaganti]

William,

Thanks for trying it out!

On Mon, May 30, 2011 at 9:16 AM, William Henney <whenney@gmail.com> wrote:
>
> This looks very promising - thanks! It is a shame though that the body
> of the issue and the comments don't get synched (I see that you have
> these listed as TODO). I also noticed that if I type any text directly

This is Experimental and I am open to suggestions, but one of the
problems I have is that the GitHub API v3 is unstable and causing some
trouble. I initially had a version, where the BODY of the issue was
being sync-ed, but after a while, I stopped getting the body of the
issue in the JSON. I'm not sure what went wrong, but a simple GET
using curl also failed to give me the body.  I shall look at it again,
in a short while.


> under the issue's heading in my org file, then this text is /wiped/
> when I execute =org-ghi-update-current-issue=. However, any
> subheadings (and their text) do survive, but they never get synched
> back to GitHub.

I haven't figured out what would be the right way to do this. I am
open to any suggestions from your side.

Thanks,
Puneeth

Re: [Announce] A GitHub Issues interface for Org-mode

[William Henney]

Hi Puneeth

On Sun, May 29, 2011 at 11:43 PM, Puneeth Chaganti <punchagan@gmail.com> wrote:
> William,
>
> Thanks for trying it out!
>

No problem - anything to avoid doing my real work....

> On Mon, May 30, 2011 at 9:16 AM, William Henney <whenney@gmail.com> wrote:
>>
>> This looks very promising - thanks! It is a shame though that the body
>> of the issue and the comments don't get synched (I see that you have
>> these listed as TODO). I also noticed that if I type any text directly
>
> This is Experimental and I am open to suggestions, but one of the
> problems I have is that the GitHub API v3 is unstable and causing some
> trouble. I initially had a version, where the BODY of the issue was
> being sync-ed, but after a while, I stopped getting the body of the
> issue in the JSON. I'm not sure what went wrong, but a simple GET
> using curl also failed to give me the body.  I shall look at it again,
> in a short while.
>

Is the v2 API missing some features you need? Maybe it would be better
to use that until v3 is out of beta

>
>> under the issue's heading in my org file, then this text is /wiped/
>> when I execute =org-ghi-update-current-issue=. However, any
>> subheadings (and their text) do survive, but they never get synched
>> back to GitHub.
>
> I haven't figured out what would be the right way to do this. I am
> open to any suggestions from your side.
>

Well, the wiping of text directly below an issue's level 2 heading is
a data-loss bug, so I would suggest that you certainly don't do that
:)

With respect to sub-headings (level 3 or below) that are added by hand
to the github.org file, I would suggest that by default you do not
sync them with GitHub. Maybe you could have a function called
something like org-ghi-make-heading-a-comment that would work in a
similar way to org-ghi-make-todo-an-issue. However, it seems that
GitHub issue comments only understand markdown syntax, not org syntax,
so unless the comment is just simple text it would require an export
step (https://github.com/alexhenning/ORGMODE-Markdown might help
there).

Cheers

Will


-- 

  Dr William Henney, Centro de Radioastronomía y Astrofísica,
  Universidad Nacional Autónoma de México, Campus Morelia

Re: [Announce] A GitHub Issues interface for Org-mode

[Puneeth Chaganti]

Hi William,

On Mon, May 30, 2011 at 8:08 PM, William Henney <whenney@gmail.com> wrote:
[..]
> Is the v2 API missing some features you need? Maybe it would be better
> to use that until v3 is out of beta

v2 API doesn't provide access to the new features of Issues, added in
version 2 of GitHub Issues, like Milestones. I thought adding the
Milestone due date as a deadline would be useful. But, as you suggest,
I should probably try things with APIv2 until the v3 is more stable.

[..]

> Well, the wiping of text directly below an issue's level 2 heading is
> a data-loss bug, so I would suggest that you certainly don't do that
> :)

Yes. I'll fix it, as soon as I get some time and am able to move stuff to v2.

> With respect to sub-headings (level 3 or below) that are added by hand
> to the github.org file, I would suggest that by default you do not
> sync them with GitHub. Maybe you could have a function called
> something like org-ghi-make-heading-a-comment that would work in a
> similar way to org-ghi-make-todo-an-issue. However, it seems that
> GitHub issue comments only understand markdown syntax, not org syntax,
> so unless the comment is just simple text it would require an export
> step (https://github.com/alexhenning/ORGMODE-Markdown might help
> there).

Thanks for the suggestions, will look into them. :)

--
Puneeth