From 66560432ce466547d3ed32282680d0ac479c1889 Mon Sep 17 00:00:00 2001 From: spacewander Date: Thu, 28 Jul 2016 00:08:20 +0800 Subject: [PATCH] add doc for git-pull-request and others --- Commands.md | 32 ++++++++- bin/git-fork | 2 +- bin/git-pull-request | 8 ++- etc/git-extras-completion.zsh | 1 + man/git-pull-request.1 | 46 ++++++++++++ man/git-pull-request.html | 127 ++++++++++++++++++++++++++++++++++ man/git-pull-request.md | 44 ++++++++++++ 7 files changed, 255 insertions(+), 5 deletions(-) create mode 100644 man/git-pull-request.1 create mode 100644 man/git-pull-request.html create mode 100644 man/git-pull-request.md diff --git a/Commands.md b/Commands.md index c59c8d4e6..90ddc9895 100644 --- a/Commands.md +++ b/Commands.md @@ -36,20 +36,19 @@ - [`git obliterate`](#git-obliterate) - [`git pr`](#git-pr) - [`git psykorebase`](#git-psykorebase) + - [`git pull-request`](#git-pull-request) - [`git rebase-patch`](#git-rebase-patch) - [`git release`](#git-release) + - [`git rename-tag`](#git-rename-tag) - [`git repl`](#git-repl) - [`git reset-file`](#git-reset-file) - [`git root`](#git-root) - [`git scp`](#git-scp) - [`git sed`](#git-sed) - [`git setup`](#git-setup) -<<<<<<< HEAD -======= - [`git show-merged-branches`](#git-show-merged-branches) - [`git show-unmerged-branches`](#git-show-unmerged-branches) - [`git show-tree`](#git-show-tree) ->>>>>>> 7c693c3... add git-show-(un)merged-branches to Commands.md - [`git standup`](#git-standup) - [`git squash`](#git-squash) - [`git summary`](#git-summary) @@ -348,6 +347,29 @@ Does the following: - Push the branch / tags - Executes _.git/hooks/post-release.sh_ (if present) +## git rename-tag + +Rename a tag (locally and remotely). +``` +$ git tag test +$ git push --tags +Total 0 (delta 0), reused 0 (delta 0) +To git@myserver.com:myuser/myrepository.git + * [new tag] test -> test +$ git tag +test +$ git rename-tag test test2 +Deleted tag 'test' (was 1111111) +Total 0 (delta 0), reused 0 (delta 0) +To git@myserver.com:myuser/myrepository.git + * [new tag] test2 -> test2 +remote: warning: Deleting a non-existent ref. +To git@myserver.com:myuser/myrepository.git + - [deleted] refs/tag/test +$ git tag +test2 +``` + ## git alias Define, search and show aliases. @@ -1050,6 +1072,10 @@ $ git psykorebase master feature The above rebase `feature` branch on top of `master` branch +## git pull-request + +Create pull request via commandline. + ## git rebase-patch Given you have a patch that doesn´t apply to the current HEAD, but you know it applied to some commit in the past, diff --git a/bin/git-fork b/bin/git-fork index 0981488d4..b05cb0594 100755 --- a/bin/git-fork +++ b/bin/git-fork @@ -20,7 +20,7 @@ read user # extract owner + project from repo url project=${url##*/} owner=${url%/$project} -[[ $project == *.git ]] && project=${project%.git} +project=${project%.git} if [[ $owner == git@* ]]; then owner=${owner##*:} else diff --git a/bin/git-pull-request b/bin/git-pull-request index e9a2e44bd..72e8a9d01 100755 --- a/bin/git-pull-request +++ b/bin/git-pull-request @@ -39,7 +39,13 @@ git push origin $branch || abort "failed to push $branch" # lame hack to get project -project=$(git config remote.origin.url | sed 's/^.*://' | sed 's/\.git$//') +origin=$(git config remote.origin.url) +if [[ $origin == git@* ]]; then + project=${origin##*:} +else + project=${origin#https://*/} +fi +project=${project%.git} # prompt diff --git a/etc/git-extras-completion.zsh b/etc/git-extras-completion.zsh index 84ccc1bc4..b6dec9b65 100644 --- a/etc/git-extras-completion.zsh +++ b/etc/git-extras-completion.zsh @@ -389,6 +389,7 @@ zstyle ':completion:*:*:git:*' user-commands \ obliterate:'rewrite past commits to remove some files' \ pr:'checks out a pull request locally' \ psykorebase:'rebase a branch with a merge commit' \ + pull-request:'create pull request to GitHub project' \ rebase-patch:'rebases a patch' \ refactor:'create refactor branch' \ release:'commit, tag and push changes to the repository' \ diff --git a/man/git-pull-request.1 b/man/git-pull-request.1 new file mode 100644 index 000000000..f4390cdb0 --- /dev/null +++ b/man/git-pull-request.1 @@ -0,0 +1,46 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "GIT\-PULL\-REQUEST" "1" "July 2016" "" "" +. +.SH "NAME" +\fBgit\-pull\-request\fR \- Create pull request for GitHub project +. +.SH "SYNOPSIS" +\fBgit\-pull\-request\fR [] +. +.SH "DESCRIPTION" +Create pull request for a project on GitHub via commandline\. +. +.SH "OPTIONS" + +. +.P +The target branch you want to send pull request to\. +. +.SH "EXAMPLES" +. +.nf + +$ git pull\-request master +Everything up\-to\-date + + create pull\-request for spacewander/spacewander\-toolbox \'master\' + + title: test + body: + base [master]: + +Enter host password for user \'spacewanderlzx@gmail\.com\': +\.\.\. +. +.fi +. +.SH "AUTHOR" +Written by Tj Holowaychuk <\fItj@vision\-media\.ca\fR> +. +.SH "REPORTING BUGS" +<\fIhttps://github\.com/tj/git\-extras/issues\fR> +. +.SH "SEE ALSO" +<\fIhttps://github\.com/tj/git\-extras\fR> diff --git a/man/git-pull-request.html b/man/git-pull-request.html new file mode 100644 index 000000000..e190e72f8 --- /dev/null +++ b/man/git-pull-request.html @@ -0,0 +1,127 @@ + + + + + + git-pull-request(1) - Create pull request for GitHub project + + + + +
+ + + +
    +
  1. git-pull-request(1)
    2. +
  2. +
  3. git-pull-request(1)
    4. +
+ +

NAME

+

+ git-pull-request - Create pull request for GitHub project +

+ +

SYNOPSIS

+ +

git-pull-request [<target branch>]

+ +

DESCRIPTION

+ +

Create pull request for a project on GitHub via commandline.

+ +

OPTIONS

+ +

<target branch>

+ +

The target branch you want to send pull request to.

+ +

EXAMPLES

+ +
$ git pull-request master
+Everything up-to-date
+
+  create pull-request for spacewander/spacewander-toolbox 'master'
+
+  title: test
+  body:  
+  base [master]: 
+
+Enter host password for user 'spacewanderlzx@gmail.com':
+...
+
+ +

AUTHOR

+ +

Written by Tj Holowaychuk <tj@vision-media.ca>

+ +

REPORTING BUGS

+ +

<https://github.com/tj/git-extras/issues>

+ +

SEE ALSO

+ +

<https://github.com/tj/git-extras>

+ + +
    +
  1. +
  2. July 2016
    3. +
  3. git-pull-request(1)
    4. +
+ +
+ + diff --git a/man/git-pull-request.md b/man/git-pull-request.md new file mode 100644 index 000000000..133242cf6 --- /dev/null +++ b/man/git-pull-request.md @@ -0,0 +1,44 @@ +git-pull-request(1) -- Create pull request for GitHub project +================================ + +## SYNOPSIS + +`git-pull-request` [<target branch>] + +## DESCRIPTION + +Create pull request for a project on GitHub via commandline. + +## OPTIONS + +<target branch> + +The target branch you want to send pull request to. + +## EXAMPLES + +``` +$ git pull-request master +Everything up-to-date + + create pull-request for spacewander/spacewander-toolbox 'master' + + title: test + body: + base [master]: + +Enter host password for user 'spacewanderlzx@gmail.com': +... +``` + +## AUTHOR + +Written by Tj Holowaychuk <> + +## REPORTING BUGS + +<> + +## SEE ALSO + +<>