Table of Contents

GitHub layer

Table of ContentsClose

github.png

1 Description

This layers adds support for GitHub.

1.1 Features:

2 Install

2.1 Layer

To use this configuration layer, add it to your ~/.spacemacs. You will need to add github to the existing dotspacemacs-configuration-layers list in this file.

2.2 Git configuration

You will need to generate a personal access token on GitHub. This token should have the gist and repo permissions. Once this token is created, it needs to be added to your ~/.gitconfig

git config --global github.oauth-token <token>

3 Key Bindings

3.1 magit-gh-pulls

In a magit status buffer (SPC g s):

Key Binding Description
# c create a pull request
# g get a list of (or reload) all PRs in the current repository
# f fetch the commits associated with the current PR at point
# b create a branch for the current PR at point
# m merge the PR with current branch at point
# d show a diff of the current pull request at point
# o open PR at point in browser

Note that magit-gh-pulls will try to fast-forward the PRs whenever it is possible.

3.2 gist.el

Key Binding Description
SPC g g b create a public gist with the buffer content
SPC g g B create a private gist with the buffer content
SPC g g l open the gist list buffer
SPC g g r create a public gist with the region content
SPC g g R create a private gist with the region content

In the gist list buffer:

Key Binding Description
/ evil search
+ add buffer to gist
- remove file for gist
b or o open current gist in browser
f fetch current gist
g refresh the list
h go left
j go down
k go up
K kill current gist
l go right
n next search occurrence
N next previous occurrence
v visual state
V visual-line state
y print URL and copy it

3.3 Clone repositories

Key Binding Description
SPC g h c / search for a repository to clone it
SPC g h c c clone and optionally fork repository
SPC g h c r add a remote that is an existing fork of selected remote
SPC g h c f fork remote in current user namespace
SPC g h c u add upstream as remote

3.4 Browse files

Key Binding Description
SPC g h o browse to file on GitHub

Author: Sylvain Benner

Created: 2016-10-03 Mon 00:55

Validate