Adding workflow for pull requests - Githubissues

jaxbot / github-issues.vim

Github issue lookup in Vim

http://jaxbot.me/articles/github-issues-vim-plugin-5-7-2014

Other

405 stars 28 forks source link

Adding workflow for pull requests #139

Closed TheJefe closed 9 years ago

TheJefe commented 9 years ago

Sorry this PR became so big, but it didn't make sense to open a PR until an entire workflow was implemented. It might be best to review it commit by commit.

The general purpose of this change was to support a pull request based workflow. I started working on the vim-prreview plugin before I knew that this project exisited. So after finding github-issues.vim, I chose to simply open github-issues.vim up to allow access from other plugins. Then since this was for a pull request workflow, it only made since to be able to view commit lists and changes, very much like github has from its pull requests view on the webpage.

This PR does a few things, that I have listed below.

use a file to get github access token, because it is not secure to store it in your vimrc when you back it up to github.
allow other plugins to use this one by allowing passing params in for repo and number of an issue
add "Commits" and "Files Changed" tags to an issue display. When pressing enter on them, you'll get a list of commits or it will show the file diffs for the pull request
allow a user to press enter on the commit list to open "Gedit" for that commit.
hit github's api for commit diffs rather then use fugitive, because this way we don't have to worry about having the repo available locally.
open links in a new tab or split. 's' mapped for split, <CR> for new tab
Demos from vim-prreview

vim-prreview

Commits using the-jefe/github-issues.vim

commits

File Diff using the-jefe/github-issues.vim

file_diff

jaxbot commented 9 years ago

This is awesome! Gimme a bit to sort through this all ;)

jaxbot commented 9 years ago

Note about:

use a file to get github access token, because it is not secure to store it in your vimrc when you back it up to github.

Well, I don't expect people to put it in their vimrc, just source it from somewhere. But if it works seamlessly, no reason not to switch it, so long as it's backwards compatible somehow

jaxbot commented 9 years ago

Also, where is :PR defined?

TheJefe commented 9 years ago

as far as the github token goes, I'm just as happy to define it as an environment variable, as long as it is not in a config file that is likely to be checked in, I don't really care.

PR is defined in vim-prreview . I did that work before I knew this plugin existed, otherwise I would have likely added that stuff to this project.

jaxbot commented 9 years ago

Ah, duh. Gotcha. Alright, I'll test out GHI.vim and make sure everything works as usual, then add in vim-prreview and give that a whurl. Sorry for the delay on getting back to you. It's a homework weekend :\

TheJefe commented 9 years ago

Delay? I'm surprised you got back to me this quick :) . thanks again for reviewing

On Sun, Mar 29, 2015, 1:57 PM Jonathan Warner notifications@github.com wrote:

Ah, duh. Gotcha. Alright, I'll test out GHI.vim and make sure everything works as usual, then add in vim-prreview and give that a whurl. Sorry for the delay on getting back to you. It's a homework weekend :\

— Reply to this email directly or view it on GitHub https://github.com/jaxbot/github-issues.vim/pull/139#issuecomment-87450478 .

jaxbot commented 9 years ago

Gissues seems to work, diff looks alright. I'm going to merge it in, but I'm going to diverge it from your branch after that for some formatting changes, so if you have more changes to make, just make sure you pull in my master.

TheJefe commented 9 years ago

Excellent! thanks very much!