summaryrefslogtreecommitdiff
path: root/plugins/github
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/github')
-rw-r--r--plugins/github/README.md10
-rw-r--r--plugins/github/_hub11
2 files changed, 15 insertions, 6 deletions
diff --git a/plugins/github/README.md b/plugins/github/README.md
index 2b66e390f..70b863f64 100644
--- a/plugins/github/README.md
+++ b/plugins/github/README.md
@@ -1,4 +1,4 @@
-# github
+# github plugin
This plugin supports working with GitHub from the command line. It provides a few things:
@@ -6,7 +6,7 @@ This plugin supports working with GitHub from the command line. It provides a fe
* Completion for the `github` Ruby gem.
* Convenience functions for working with repos and URLs.
-### Functions
+### Functions
* `empty_gh` - Creates a new empty repo (with a `README.md`) and pushes it to GitHub
* `new_gh` - Initializes an existing directory as a repo and pushes it to GitHub
@@ -14,13 +14,13 @@ This plugin supports working with GitHub from the command line. It provides a fe
* `git.io` - Shortens a URL using [git.io](https://git.io)
-## Installation
+## Installation
[Hub](https://github.com/github/hub) needs to be installed if you want to use it. On OS X with Homebrew, this can be done with `brew install hub`. The `hub` completion definition needs to be added to your `$FPATH` before initializing OMZ.
The [`github` Ruby gem](https://github.com/defunkt/github-gem) needs to be installed if you want to use it.
-### Configuration
+### Configuration
These settings affect `github`'s behavior.
@@ -35,7 +35,7 @@ These settings affect `github`'s behavior.
See `man hub` for more details.
-### Homebrew installation note
+### Homebrew installation note
If you have installed `hub` using Homebrew, its completions may not be on your `$FPATH` if you are using the system `zsh`. Homebrew installs `zsh` completion definitions to `/usr/local/share/zsh/site-functions`, which will be on `$FPATH` for the Homebrew-installed `zsh`, but not for the system `zsh`. If you want it to work with the system `zsh`, add this to your `~/.zshrc` before it sources `oh-my-zsh.sh`.
diff --git a/plugins/github/_hub b/plugins/github/_hub
index 1833a9c09..209a3df9e 100644
--- a/plugins/github/_hub
+++ b/plugins/github/_hub
@@ -58,6 +58,7 @@ __hub_setup_zsh_fns () {
- set1 \
'-m[message]' \
'-F[file]' \
+ '--no-edit[use first commit message for pull request title/description]' \
'-a[user]' \
'-M[milestone]' \
'-l[labels]' \
@@ -84,11 +85,15 @@ __hub_setup_zsh_fns () {
hub_commands=(
alias:'show shell instructions for wrapping git'
pull-request:'open a pull request on GitHub'
+ pr:'list or checkout a GitHub pull request'
+ issue:'list or create a GitHub issue'
+ release:'list or create a GitHub release'
fork:'fork origin repo on GitHub'
create:'create new repo on GitHub for the current project'
+ delete:'delete a GitHub repo'
browse:'browse the project on GitHub'
compare:'open GitHub compare view'
- ci-status:'lookup commit in GitHub Status API'
+ ci-status:'show status of GitHub checks for a commit'
sync:'update local branches from upstream'
)
_describe -t hub-commands 'hub command' hub_commands && ret=0
@@ -111,8 +116,12 @@ __hub_setup_bash_fns () {
cat <<-EOF
alias
pull-request
+pr
+issue
+release
fork
create
+delete
browse
compare
ci-status