akhileshs / magithub

Magit interfaces for GitHub

Magithub

Magithub is a collection of interfaces to GitHub.

Integrated into Magit workflows, Magithub allows easy GitHub repository management. Supported actions from the status buffer include:

• H H open the current repo in the browser
• H c push brand-new local repositories up to GitHub
• H f create forks of existing repositories
• H p submit pull requests upstream
• H i create issues
• L on an issue (or pull request) updates its labels
• RET on an issue to open that issue in GitHub
• RET on the CI header to open your CI dashboard

For when you're on the run, you can set magithub-cache to t to activate 'offline mode' (or use H O from the status buffer). This will inhibit all API requests and instead rely on cached data.

Happy hacking!

Installation

The package can be installed from MELPA. Otherwise, simply place magithub.el in your load-path and (require 'magithub). Use the function magithub-feature-autoinject to add full Magit workflow integration.

If you use use-package, you should instead use:

(use-package magithub
  :after magit
  :config (magithub-feature-autoinject t))

To authenticate ghub, see its README. However, since its authentication approach is still in flux, you might consider setting the following variables appropriately until it's stable:

ghub-base-url     ;; base API url; customize if GitHub Enterprise
ghub-username     ;; your username
ghub-token        ;; your personal access token

See GitHub's settings for information on how to create tokens.

For some advanced trickery features, Magithub still requires the hub utility to work -- so before trying to use those features, follow the installation instructions at hub.github.com. To force hub to authenticate, you can use hub browse in a terminal (inside a GitHub repo).

Support

I'm gainfully and happily employed with a company that frowns on moonlighting, so unfortunately I can't accept any donations myself. Instead, please direct any and all support to Magit itself!

Note

There used to be another magithub: nex3/magithub. It's long-since unsupported and apparently has many issues (see nex3/magithub#11 and nex3/magithub#13) and was removed from MELPA some years ago. If you have it installed or configured, you may wish to remove/archive that configuration to avoid name-clash issues. Given that the package has been defunct for over three years and is likely abandoned, the present package's name will not be changing.