git-process 1.1.4 → 2.0.0

data/man/git-process.1

@@ -0,0 +1,371 @@
+'\" t
+.\"     Title: git-process
+.\"    Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 09/11/2013
+.\"    Manual: \ \&
+.\"    Source: \ \&
+.\"  Language: English
+.\"
+.TH "GIT\-PROCESS" "1" "09/11/2013" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+git-process \- A suite of tools to make it easy to use an easy and robust git process\&.
+.SH "DESCRIPTION"
+.sp
+\fIgit\-process(1)\fR consists of a small suite of tools that make it easy to follow a simple, consistent process that scales from simple one\-person projects to very large (dozens of developers) collaboration\&. It does this by taking advantage of "classic" methodologies like "Git Flow" and GitHub pull requests to have "just enough" process\&. See \fBWORKFLOW EXAMPLES\fR to see this in practice\&.
+.SH "COMMON OPTIONS"
+.PP
+\fB\-\-info\fR
+.RS 4
+Informational messages; show the major things this is doing (\fBdefault: true\fR)
+.RE
+.PP
+\fB\-q, \-\-quiet\fR
+.RS 4
+Quiet messages; only show errors
+.RE
+.PP
+\fB\-v, \-\-verbose\fR
+.RS 4
+Verbose messages; show lots of details on what this is doing
+.RE
+.PP
+\fB\-\-version\fR
+.RS 4
+Print version and exit
+.RE
+.SH "CONFIGURATION"
+.PP
+\fBgitProcess\&.remoteName\fR
+.RS 4
+Allows you to explicitly set the remote server name to use\&. Defaults to the first server name reported by
+\fIgit\-remote(1)\fR\&.
+.RE
+.PP
+\fBgitProcess\&.integrationBranch\fR
+.RS 4
+Allows you to explicitly set the integration branch to use\&. Defaults to "master"\&.
+.RE
+.PP
+\fBgitProcess\&.defaultRebaseSync\fR
+.RS 4
+Should
+\fIgit\-sync(1)\fR
+use
+\fB\-\-rebase\fR
+by default instead of
+\fB\-\-merge\fR? Defaults to
+\fBtrue\fR\&.
+.RE
+.PP
+\fBgitProcess\&.github\&.authtoken\fR
+.RS 4
+Not meant to be set manually, this is the OAuth token used to communicate with the GitHub server\&. If it is not set, the user will be prompted for their credentials\&.
+.RE
+.PP
+\fBgithub\&.user\fR
+.RS 4
+If OAuth needs to prompt for credentials, if this value is set then it is used as the username\&. Otherwise it is unused\&.
+.RE
+.SH "WORKFLOW EXAMPLES"
+.SS "WORKING ALONE ON A LOCAL\-ONLY PROJECT"
+.sp
+Jim is working on "my_project" and needs to start work on a new feature\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+[a_branch]$ git new\-fb save_the_planet
+  Creating save_tp off of master
+[save_the_planet]$
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+He does lots of work\&. Checkin, checkin, checkin\&.
+.sp
+A sudden new brilliant idea happens\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+[save_the_planet]$ git new\-fb shave_the_bunnies
+  Creating shave_the_bunnies off of master
+[shave_the_bunnies]$
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+After creating a Sheering class and tests, he commits his changes\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+[shave_the_bunnies]$ git commit
+[shave_the_bunnies]$ git to\-master
+  Rebasing shave_the_bunnies against master
+  Removing branch \*(Aqshave_the_bunnies\*(Aq
+[_parking_]$
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Time to get back to work on "save_the_planet"\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+[_parking_]$ git checkout save_the_planet
+[save_the_planet]$ git sync
+  Rebasing save_the_planet against master
+[save_the_planet]$
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Do more work\&. Commit\&. Commit\&. Commit\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+[save_the_planet]$ git sync
+  Rebasing save_the_planet against master
+[save_the_planet]$
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Liking to have a clean history, he squashes and edits the commits to hide the evidence of false starts and stupid ideas so that anyone who sees the code in the future will think he was simply a genius\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+[save_the_planet]$ git rebase \-i
+  Rebasing save_the_planet against master
+[save_the_planet]$ git to\-master
+  Rebasing save_the_planet against master
+  Removing branch \*(Aqsave_the_planet\*(Aq
+[_parking_]$
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Time to release to a grateful world\&.
+.SS "WORKING WITH A TEAM"
+.sp
+John, Alice, Bill and Sally are working on "big_monies\&." Alice and John are pairing and need to start work on a new feature\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+john\-[a_branch]$ git new\-fb steal_underpants
+  Fetching the latest changes from the server
+  Creating steal_underpants off of origin/master
+john\-[steal_underpants]$
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+They do lots of work\&. Checkin, checkin, checkin\&. It has a lot of steps\&...
+.sp
+Meanwhile Bill has been working on his great idea:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+bill\-[some_branch]$ git new\-fb awesomo4000
+  Fetching the latest changes from the server
+  Creating awesomo4000 off of origin/master
+bill\-[awesomo4000]$
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+He creates his "Laaaaame" class and checks it in, with a pull request asking Sally to do a code review\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+bill\-[awesomo4000]$ git commit
+bill\-[awesomo4000]$ git pull\-request "A\&.W\&.E\&.S\&.O\&.M\-0 4000 prototype" \e
+                    \-d "@sally, can you make sure Butters won\*(Aqt recognize it?"
+  Pushing to \*(Aqawesomo4000\*(Aq on \*(Aqorigin\*(Aq\&.
+  Creating a pull request asking for \*(Aqawesomo4000\*(Aq to be merged into \*(Aqmaster\*(Aq on big_monies\&.
+  Created pull request at https://github\&.com/big_monies/pull/3454
+bill\-[awesomo4000]$
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Sally sees the email\&. After looking at it in the web interface, she wants to test it\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+sally\-[other_branch]$ git pull\-request 3454
+  Getting #pr_number
+  Fetching the latest changes from the server
+    new branch: awesomo4000
+  Setting upstream/tracking for branch \*(Aqawesomo4000\*(Aq to \*(Aqorigin/master\*(Aq\&.
+sally\-[awesomo4000]$ git sync
+  Fetching the latest changes from the server
+  Rebasing awesomo4000 against origin/master
+  Pushing to \*(Aqawesomo4000\*(Aq on \*(Aqorigin\*(Aq\&.
+sally\-[awesomo4000]$
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+After verifying that the tests still work and "it\(cqs all good" she promotes the code to integration\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+sally\-[awesomo4000]$ git to\-master
+  Fetching the latest changes from the server
+  Rebasing awesomo4000 against origin/master
+  Pushing to \*(Aqawesomo4000\*(Aq on \*(Aqorigin\*(Aq\&.
+  Removing branch remote \*(Aqawesomo4000\*(Aq
+  Removing branch local \*(Aqawesomo4000\*(Aq
+  Closing a pull request #3454 on origin\&.
+sally\-[_parking_]$
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Over lunch Alice gets a brainstorm ("a duck and rubber hose!") and rushes off to her computer:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+alice\-[lens_cap]$ git sync steal_underpants
+  Fetching the latest changes from the server
+  Creating steal_underpants off of origin/steal_underpants
+  Setting upstream/tracking for branch \*(Aqsteal_underpants\*(Aq to \*(Aqorigin/master\*(Aq\&.
+alice\-[steal_underpants]$
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+She makes her changes, syncs back up with the server, and heads over to pair with John again\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+alice\-[steal_underpants]$ git commit
+alice\-[steal_underpants]$ git sync
+  Fetching the latest changes from the server
+  Rebasing steal_underpants against origin/master
+  Pushing to \*(Aqsteal_underpants\*(Aq on \*(Aqorigin\*(Aq\&.
+alice\-[steal_underpants]$
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+John, meanwhile, had made some changes of his own\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+john\-[steal_underpants]$ git commit
+john\-[steal_underpants]$ git sync
+  Fetching the latest changes from the server
+  Remote branch has changed
+  Rebasing steal_underpants against origin/steal_underpants
+  Rebasing steal_underpants against origin/master
+  Pushing to \*(Aqsteal_underpants\*(Aq on \*(Aqorigin\*(Aq\&.
+john\-[steal_underpants]$
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+At this point, his local branch has Alice\(cqs change as well as Bill and Sally\(cqs A\&.W\&.E\&.S\&.O\&.M\-O 4000 enhancements\&.
+.sp
+After confirming with Alice and Bill that everything looks good, he pushes his changes up for integration\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+john\-[steal_underpants]$ git to\-master
+  Fetching the latest changes from the server
+  Rebasing steal_underpants against origin/master
+  Pushing to \*(Aqsteal_underpants\*(Aq on \*(Aqorigin\*(Aq\&.
+  Removing remote branch \*(Aqsteal_underpants\*(Aq
+  Removing local branch \*(Aqsteal_underpants\*(Aq
+[_parking_]$
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Profit!!
+.SH "CONTROL FILES"
+.PP
+\fBgitprocess\-sync\-\fR*\fB\-\-\fR*
+.RS 4
+To help make the process simpler and more reliable,
+\fIgit\-sync(1)\fR
+will put a file in the "\fI\&.git\fR" directory that contains the SHA\-1 of the last successful sync to the server\&.
+\fIgit\-to\-master(1)\fR
+will remove the file as part of its normal "housekeeping\&."
+.RE
+.SH "SEE ALSO"
+.sp
+\fBgit\-sync\fR(1), \fBgit\-to\-master\fR(1), \fBgit\-new\-fb\fR(1), \fBgit\-pull\-request\fR(1)
+.SH "BUGS"
+.sp
+Known bug list: https://github\&.com/jdigger/git\-process/issues?state=open
+.SH "AUTHOR"
+.sp
+git\-process has been written primarily by Jim Moore\&.
+.SH "RESOURCES"
+.sp
+Main web site: https://github\&.com/jdigger/git\-process

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: git-process
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 15
   prerelease: 
   segments: 
-  - 1
-  - 1
-  - 4
-  version: 1.1.4
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Jim Moore
@@ -15,156 +15,88 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-05-02 00:00:00 Z
+date: 2013-09-11 00:00:00 -06:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: octokit
+  name: git-sync
   prerelease: false
-  type: :runtime
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 63
+        hash: 15
         segments: 
-        - 1
-        - 24
-        version: "1.24"
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
-  prerelease: false
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
   type: :runtime
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 1
-        - 7
-        - 3
-        version: 1.7.3
-  requirement: *id002
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: trollop
+  name: git-new-fb
   prerelease: false
-  type: :runtime
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 83
+        hash: 15
         segments: 
-        - 1
-        - 16
         - 2
-        version: 1.16.2
-  requirement: *id003
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: highline
+  name: git-to-master
   prerelease: false
-  type: :runtime
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 21
+        hash: 15
         segments: 
-        - 1
-        - 6
-        - 13
-        version: 1.6.13
-  requirement: *id004
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: addressable
+  name: git-pull-request
   prerelease: false
-  type: :runtime
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 11
+        hash: 15
         segments: 
         - 2
-        - 3
-        - 4
-        version: 2.3.4
-  requirement: *id005
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id004
 description: A set of scripts to make working with git easier and more consistent
 email: 
 - moore.jim@gmail.com
-executables: 
-- git-new-fb
-- git-pull-request
-- git-sync
-- git-to-master
+executables: []
+
 extensions: []
 
 extra_rdoc_files: []
 
 files: 
-- CHANGELOG.md
-- Gemfile
-- Gemfile.lock
-- LICENSE
 - README.md
-- Rakefile
-- bin/git-new-fb
-- bin/git-pull-request
-- bin/git-sync
-- bin/git-to-master
-- git-process.gemspec
-- lib/git-process/abstract_error_builder.rb
-- lib/git-process/changed_file_helper.rb
-- lib/git-process/git_abstract_merge_error_builder.rb
-- lib/git-process/git_branch.rb
-- lib/git-process/git_branches.rb
-- lib/git-process/git_config.rb
-- lib/git-process/git_lib.rb
-- lib/git-process/git_logger.rb
-- lib/git-process/git_merge_error.rb
-- lib/git-process/git_process.rb
-- lib/git-process/git_process_error.rb
-- lib/git-process/git_process_options.rb
-- lib/git-process/git_rebase_error.rb
-- lib/git-process/git_remote.rb
-- lib/git-process/git_status.rb
-- lib/git-process/github_configuration.rb
-- lib/git-process/github_pull_request.rb
-- lib/git-process/new_fb.rb
-- lib/git-process/parked_changes_error.rb
-- lib/git-process/pull_request.rb
-- lib/git-process/pull_request_error.rb
-- lib/git-process/rebase_to_master.rb
-- lib/git-process/sync.rb
-- lib/git-process/uncommitted_changes_error.rb
-- lib/git-process/version.rb
-- spec/FileHelpers.rb
-- spec/GitRepoHelper.rb
-- spec/changed_file_helper_spec.rb
-- spec/git_abstract_merge_error_builder_spec.rb
-- spec/git_branch_spec.rb
-- spec/git_config_spec.rb
-- spec/git_lib_spec.rb
-- spec/git_logger_spec.rb
-- spec/git_process_spec.rb
-- spec/git_remote_spec.rb
-- spec/git_status_spec.rb
-- spec/github_configuration_spec.rb
-- spec/github_pull_request_spec.rb
-- spec/github_test_helper.rb
-- spec/new_fb_spec.rb
-- spec/pull_request_helper.rb
-- spec/pull_request_spec.rb
-- spec/rebase_to_master_spec.rb
-- spec/spec_helper.rb
-- spec/sync_spec.rb
+- LICENSE
+- CHANGELOG.md
+- man/git-process.1
+has_rdoc: true
 homepage: http://jdigger.github.com/git-process/
 licenses: 
 - ASL2
@@ -196,29 +128,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A set of scripts for a good git process
-test_files: 
-- spec/FileHelpers.rb
-- spec/GitRepoHelper.rb
-- spec/changed_file_helper_spec.rb
-- spec/git_abstract_merge_error_builder_spec.rb
-- spec/git_branch_spec.rb
-- spec/git_config_spec.rb
-- spec/git_lib_spec.rb
-- spec/git_logger_spec.rb
-- spec/git_process_spec.rb
-- spec/git_remote_spec.rb
-- spec/git_status_spec.rb
-- spec/github_configuration_spec.rb
-- spec/github_pull_request_spec.rb
-- spec/github_test_helper.rb
-- spec/new_fb_spec.rb
-- spec/pull_request_helper.rb
-- spec/pull_request_spec.rb
-- spec/rebase_to_master_spec.rb
-- spec/spec_helper.rb
-- spec/sync_spec.rb
-has_rdoc: 
+test_files: []
+