Difference between revisions of "Github"

From WikEmacs
Jump to navigation Jump to search
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
What are the packages and libraries that allow us to interface with github (and gitlab, and others) ?
+
What are the packages and libraries that allow us to interface with Github.
  
If you want to see packages to interfere with Git, see its own [[git]] page.
+
See also the [[Gitlab]] page.
 +
 
 +
If you want to see packages to interfere with Git, see its own [[git]] page, and of course [[Magit]].
  
 
= Packages =
 
= Packages =
  
== Github only ==
+
== Integration into Magit ==
 +
 
 +
See [https://github.com/vermiculus/magithub/ Magithub] to interact with Github directly from Magit ! Create a repo, pull requests, create issues and more.
 +
 
 +
Submit a PR:
 +
 
 +
[[File:Magithub-pull-request.gif]]
  
=== Repo interaction ===
+
== Repo interaction ==
  
 
[https://github.com/dgtized/github-clone.el github-clone] gives an interactive function to fork and clone github projets from within emacs. The command {{Command | github-clone}} will prompt for a repository and directory to clone to. In one shot, it will use the github api to fork the repo if you are not the owner, clone the repo to the specified directory, and add a remote called upstream if the repository is a fork.
 
[https://github.com/dgtized/github-clone.el github-clone] gives an interactive function to fork and clone github projets from within emacs. The command {{Command | github-clone}} will prompt for a repository and directory to clone to. In one shot, it will use the github api to fork the repo if you are not the owner, clone the repo to the specified directory, and add a remote called upstream if the repository is a fork.
  
=== Gist interaction ===
+
== Gist interaction ==
  
 
[https://github.com/mhayashi1120/yagist.el yagist], "yet another emacs integration for gist.github.com" does what it is meant for. It gives functions to list gists, create public or private gists from the region or the buffer, etc.
 
[https://github.com/mhayashi1120/yagist.el yagist], "yet another emacs integration for gist.github.com" does what it is meant for. It gives functions to list gists, create public or private gists from the region or the buffer, etc.
  
=== Pull requests ===
+
== Pull requests ==
  
 
[https://github.com/sigma/magit-gh-pulls magit-gh-pulls] is a [[magit]] extension that allows you to conveniently manipulate Github’s pull requests from Emacs. It creates a new section called "Pull requests" in the magit status buffer. From there you can see the commits of the PR, create a topic branch or merge it. You can also create a new PR.
 
[https://github.com/sigma/magit-gh-pulls magit-gh-pulls] is a [[magit]] extension that allows you to conveniently manipulate Github’s pull requests from Emacs. It creates a new section called "Pull requests" in the magit status buffer. From there you can see the commits of the PR, create a topic branch or merge it. You can also create a new PR.
  
=== Issues ===
+
== Get opened issues, special commit mode to complete on typing "Fixes #" ==
  
 
[https://gitlab.com/emacs-stuff/git-commit-insert-issue git-commit-insert-issues] gives a minor mode and an interactive function to fetch the list of issues of the project, display them with [[helm]] and insert its title in the commit message.
 
[https://gitlab.com/emacs-stuff/git-commit-insert-issue git-commit-insert-issues] gives a minor mode and an interactive function to fetch the list of issues of the project, display them with [[helm]] and insert its title in the commit message.
Line 25: Line 33:
 
[[File:git-commit-insert-issues.png]]
 
[[File:git-commit-insert-issues.png]]
  
=== Misc ===
+
== Misc ==
  
 
==== Open current file on github ====
 
==== Open current file on github ====
Line 31: Line 39:
 
There few repos doing pretty the same action: [https://github.com/osener/github-browse-file github-browse-file], [https://github.com/rmuslimov/browse-at-remote browse-at-remote]
 
There few repos doing pretty the same action: [https://github.com/osener/github-browse-file github-browse-file], [https://github.com/rmuslimov/browse-at-remote browse-at-remote]
  
==== Helm ====
+
==== Helm to open a github page ====
  
 
[https://github.com/syohex/emacs-helm-open-github emacs-helm-open-github] groups utilities to open a github page. It deals with issues, commits, files, pull requests. It is based on the gh.el library.
 
[https://github.com/syohex/emacs-helm-open-github emacs-helm-open-github] groups utilities to open a github page. It deals with issues, commits, files, pull requests. It is based on the gh.el library.
Line 38: Line 46:
  
 
Do that with [https://github.com/Sliim/helm-github-stars helm-github-stars].
 
Do that with [https://github.com/Sliim/helm-github-stars helm-github-stars].
 
== Gitlab only ==
 
 
=== gitlab.el ===
 
 
With [https://github.com/nlamirault/emacs-gitlab gitlab] we can fetch issues and projects with a [[Helm]] interface. It is also a client to gitlab's api.
 
  
 
= Libraries =
 
= Libraries =
Line 56: Line 58:
  
  
== emacs-gitlab ==
+
== ghub, a minuscule github api client ==
 +
 
  
[https://github.com/nlamirault/emacs-gitlab gitlab.el] is a rest client to gitlab's API.
+
See [https://github.com/tarsius/ghub ghub.el].
  
 
= See also =
 
= See also =

Revision as of 14:31, 21 September 2016

What are the packages and libraries that allow us to interface with Github.

See also the Gitlab page.

If you want to see packages to interfere with Git, see its own git page, and of course Magit.

Packages

Integration into Magit

See Magithub to interact with Github directly from Magit ! Create a repo, pull requests, create issues and more.

Submit a PR:

Magithub-pull-request.gif

Repo interaction

github-clone gives an interactive function to fork and clone github projets from within emacs. The command M-x github-clone will prompt for a repository and directory to clone to. In one shot, it will use the github api to fork the repo if you are not the owner, clone the repo to the specified directory, and add a remote called upstream if the repository is a fork.

Gist interaction

yagist, "yet another emacs integration for gist.github.com" does what it is meant for. It gives functions to list gists, create public or private gists from the region or the buffer, etc.

Pull requests

magit-gh-pulls is a magit extension that allows you to conveniently manipulate Github’s pull requests from Emacs. It creates a new section called "Pull requests" in the magit status buffer. From there you can see the commits of the PR, create a topic branch or merge it. You can also create a new PR.

Get opened issues, special commit mode to complete on typing "Fixes #"

git-commit-insert-issues gives a minor mode and an interactive function to fetch the list of issues of the project, display them with helm and insert its title in the commit message.

Git-commit-insert-issues.png

Misc

Open current file on github

There few repos doing pretty the same action: github-browse-file, browse-at-remote

Helm to open a github page

emacs-helm-open-github groups utilities to open a github page. It deals with issues, commits, files, pull requests. It is based on the gh.el library.

Browse your starred repos with Helm

Do that with helm-github-stars.

Libraries

gh.el

gh.el offers endpoints to connect to github's api: get issues, repositories, gists, orgs and pull requests.

github-issues.el

github-issues.el (not in melpa) allows to fetch github issues.


ghub, a minuscule github api client

See ghub.el.

See also

Magit

Magit, a git interface.

VC, the built-in version control

It's built-in. You can read its official documentation online.