Skip to content
This repository

Scripts to help work with a good Git process

Merge pull request #134 from I-Cubed/jbh-130-branch-with-slash

Issue-130 Updating to replace '/' with '-' when generating the sync control filename.

Closes GH-130
latest commit 0ee0f649a6
Jim Moore authored April 12, 2014
Octocat-spinner-32 bin git-sync -r now keeps rebase on instead of acting as a switch. September 17, 2013
Octocat-spinner-32 docs Changed git-pull-request to git-pull-req September 11, 2013
Octocat-spinner-32 lib Issue-130 Updating to replace '/' with '-' when generating the sync c… April 04, 2014
Octocat-spinner-32 spec Issue-130 Updating to replace '/' with '-' when generating the sync c… April 04, 2014
Octocat-spinner-32 .gitignore GH-128 Enable use of git 1.7 January 29, 2014
Octocat-spinner-32 .rspec Cleaned up 'require"s. June 14, 2012
Octocat-spinner-32 .ruby-version Change in rbenv metadata file July 29, 2013
Octocat-spinner-32 .travis.yml Added Ruby 2.0.0 to Travis config April 22, 2013
Octocat-spinner-32 CHANGELOG.md GH-128 Enable use of git 1.7 January 29, 2014
Octocat-spinner-32 Gemfile Locked down dependencies due to a change in the "faraday" packages January 29, 2014
Octocat-spinner-32 Gemfile.lock Locked down dependencies due to a change in the "faraday" packages January 29, 2014
Octocat-spinner-32 LICENSE Updated project metadata files July 31, 2013
Octocat-spinner-32 README.md Changed git-pull-request to git-pull-req September 11, 2013
Octocat-spinner-32 Rakefile Updates to docs and help system September 11, 2013
Octocat-spinner-32 git-new-fb.gemspec Updates to docs and help system September 11, 2013
Octocat-spinner-32 git-process-lib.gemspec Locked down dependencies due to a change in the "faraday" packages January 29, 2014
Octocat-spinner-32 git-process.gemspec Changed git-pull-request to git-pull-req September 11, 2013
Octocat-spinner-32 git-pull-req.gemspec Changed git-pull-request to git-pull-req September 11, 2013
Octocat-spinner-32 git-sync.gemspec Updates to docs and help system September 11, 2013
Octocat-spinner-32 git-to-master.gemspec Updates to docs and help system September 11, 2013
Octocat-spinner-32 local-build.rb GH-128 Enable use of git 1.7 January 29, 2014
README.md

Build Status

Purpose

This provides an easy way to work with a sane git workflow process that encourages using highly-focused branches to encourage collaboration, enable fearless changes, and improve team communication.

See the F.A.Q. for a much more complete explanation for the thoughts and assumptions that motivates this project.

Installation

Unix-based OS (OSX, Linux, etc.) Installation

If you are using a Ruby sandboxing system like RVM or rbenv (either or which I would recommend) then simply do:

$ gem install git-process

If you are not using RVM or rbenv, you will likely need to precede that with "sudo".

Some older operating systems (such as OSX 10.6) are using an old version of RubyGems, which can cause installation problems. Do "gem update --system" to fix.

Windows Installation

  1. Install Ruby (if you have not done so already) from http://rubyinstaller.org/
  2. Open a command prompt and type gem install git-process
  3. THERE IS A KNOWN PROBLEM WITH HELP ON WINDOWS.

All Operating Systems

To get full git help and manpage support, do:

$ git config --global man.gem-man.cmd "gem man -s"
$ git config --global man.viewer gem-man
$ alias man="gem man -s"

Overview

Anticipated Use Cases

  1. User creates new local branch for focused work.
  2. User pushes local branch to remote (as feature branch) by merging/rebasing with the integration branch, then pushing to the branch to remote.
  3. User closes local branch by rebasing integration branch first, then pushing local to integration.
  4. User initiates GitHub "pull request" to ease collaboration.

Command List

  • git new-fb - Create a new feature branch based on the integration branch.
  • git sync - Gets the latest changes that have happened on the integration branch and remote feature branch, then pushes your changes to a feature branch on the server.
  • git pull-req - Create or get a Pull Request for the current branch.
  • git to-master - Rebase against the integration branch, then pushes to it. Knows how to deal "intelligently" with pull-requests.

All commands are well documented within themselves: Use the "git help" to see the full documentation. (e.g., "git help sync")

Configurables

(See Notes for more details)

  • gitProcess.integrationBranch : The name of the integration branch. Defaults to master, but can be set to develop or other.
  • gitProcess.keepLocalIntegrationBranch : Controls asking about removing the local integration branch. Defaults to 'false' (i.e., do not assume the branch should be there).
  • gitProcess.remoteName : Explicitly sets the remote server name to use.
  • gitProcess.defaultRebaseSync: Should git sync default to using rebase instead of merge? Defaults to 'true' (i.e., Sync using rebase.)

Assumptions

  • You should never do any work directly on "master" (or whatever you define the mainline branch as): everything is done on a feature branch. This is a much safer and more flexible practice than doing everything on the same branch, but may seem odd to people used to old VCSs. In addition to being a much better way of working in general (see the F.A.Q. for more information), it is also a requirement to take advantage of Pull Request functionality.
  • When working on a branch, you should be integrating with "master" as often as possible.
    • "git sync" makes it extremely easy for you to get any changes that are made in "master" into your branch so you can react to it immediately.
    • "git to-master" then makes it easy to cleanly integrate the changes you have made. If you need to keep the current branch open, use the --keep option. Otherwise it closes the branch along with various other house-keeping duties.
  • The process that you use should be essentially the same, regardless of whether you are working alone, or on a large distributed team.
    • The exception here is "git pull-req" since you typically do not use pull requests when working solo or when pair-programming.

Notes

  • After publishing changes to the main integration branch (i.e., "git to-master") the old feature branch is removed as part of cleanup. Git is then "parked" on a "_parking_" branch until a new feature branch is created. Work is not expected to be done on this branch, but any that is done is brought over to a newly created feature branch (i.e., "git new-fb").
  • If there is a problem (such as a merge conflict), this will try to resolve such errors for you as much as it can do safely. When it can't do so in an automated way, it will try to tell you the process for doing so manually.
  • The first time you use a GitHub feature (e.g., "git pull-req"), this will ask for your username and password. It does not store them, but instead uses them to get an OAuth2 token, which is stored in "git config gitProcess.github.authToken".
  • If you want to use a different integration branch other than "master", set the "gitProcess.integrationBranch" configuration value. (e.g., "git config gitProcess.integrationBranch my-integ-branch")
  • By default the first server name reported by git remote is used as the server/remote name. Since most projects only have a single remote (i.e., "origin") this works most of the time. But if you have multiple remotes and want to explicitly set it, use the gitProcess.remoteName configuration option.
  • git pull-req shows the URL for the pull request after creating it on the server. Most terminal programs let you click on it to open it in your browser. (e.g., Cmd-Click on OSX.)

Workflow Examples

Working Alone On A Local-Only Project

Jim is working on "my_project" and needs to start work on a new feature.

[a_branch]$ git new-fb save_the_planet
  Creating save_tp off of master
[save_the_planet]$

He does lots of work. Checkin, checkin, checkin.

A sudden new brilliant idea happens.

[save_the_planet]$ git new-fb shave_the_bunnies
  Creating shave_the_bunnies off of master
[shave_the_bunnies]$

After creating a Sheering class and tests, he commits his changes.

[shave_the_bunnies]$ git commit
[shave_the_bunnies]$ git to-master
  Rebasing shave_the_bunnies against master
  Removing branch 'shave_the_bunnies'
[_parking_]$

Time to get back to work on "save_the_planet".

[_parking_]$ git checkout save_the_planet
[save_the_planet]$ git sync
  Rebasing save_the_planet against master
[save_the_planet]$

Do more work. Commit. Commit. Commit.

[save_the_planet]$ git sync
  Rebasing save_the_planet against master
[save_the_planet]$

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.

[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 'save_the_planet'
[_parking_]$

Time to release to a grateful world.

Working With A Team

John, Alice, Bill and Sally are working on "big_monies." Alice and John are pairing and need to start work on a new feature.

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]$

They do lots of work. Checkin, checkin, checkin. It has a lot of steps...

Meanwhile Bill has been working on his great idea:

bill-[some_branch]$ git new-fb awesomo4000
  Fetching the latest changes from the server
  Creating awesomo4000 off of origin/master
bill-[awesomo4000]$

He creates his "Laaaaame" class and checks it in, with a pull request asking Sally to do a code review.

bill-[awesomo4000]$ git commit
bill-[awesomo4000]$ git pull-req "A.W.E.S.O.M-0 4000 prototype" \
                    -d "@sally, can you make sure Butters won't recognize it?"
  Pushing to 'awesomo4000' on 'origin'.
  Creating a pull request asking for 'awesomo4000' to be merged into 'master' on big_monies.
  Created pull request at https://github.com/big_monies/pull/3454
bill-[awesomo4000]$

Sally sees the email. After looking at it in the web interface, she wants to test it.

sally-[other_branch]$ git pull-req 3454
  Getting #pr_number
  Fetching the latest changes from the server
    new branch: awesomo4000
  Setting upstream/tracking for branch 'awesomo4000' to 'origin/master'.
sally-[awesomo4000]$ git sync
  Fetching the latest changes from the server
  Rebasing awesomo4000 against origin/master
  Pushing to 'awesomo4000' on 'origin'.
sally-[awesomo4000]$

After verifying that the tests still work and "it's all good" she promotes the code to integration.

sally-[awesomo4000]$ git to-master
  Fetching the latest changes from the server
  Rebasing awesomo4000 against origin/master
  Pushing to 'awesomo4000' on 'origin'.
  Removing branch remote 'awesomo4000'
  Removing branch local 'awesomo4000'
  Closing a pull request #3454 on origin.
sally-[_parking_]$

Over lunch Alice gets a brainstorm ("a duck and rubber hose!") and rushes off to her computer:

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 'steal_underpants' to 'origin/master'.
alice-[steal_underpants]$

She makes her changes, syncs back up with the server, and heads over to pair with John again.

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 'steal_underpants' on 'origin'.
alice-[steal_underpants]$

John, meanwhile, had made some changes of his own.

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 'steal_underpants' on 'origin'.
john-[steal_underpants]$

At this point, his local branch has Alice's change as well as Bill and Sally's A.W.E.S.O.M-O 4000 enhancements.

After confirming with Alice and Bill that everything looks good, he pushes his changes up for integration.

john-[steal_underpants]$ git to-master
  Fetching the latest changes from the server
  Rebasing steal_underpants against origin/master
  Pushing to 'steal_underpants' on 'origin'.
  Removing remote branch 'steal_underpants'
  Removing local branch 'steal_underpants'
[_parking_]$

Profit!!

F.A.Q.

Q: How is this different from git-flow or GitHub flow?

"git-flow" is designed around having a very strongly defined process around keeping new development, hotfixes, release process changes, etc. all clearly separated. The problem I have with it is that it's too much "process" for not enough gain. (It has a waterfall feel to it, very much against the more modern Continuous Delivery approach.)

"GitHub Flow" is a lot cleaner, but relies too heavily (IMHO) on web-based tools and on merging instead of rebasing. It is also focussed very tightly on a Continuous Deployment process, which is great for them, but not practical for everyone.

Q: Wait, I heard "branches are evil." Why should I do something evil?

Branches are extremely powerful tools that allow for clean organization/modularization of development.

  • Branches make it easy to sandbox changes while they are in a state of flux, while at the same time allowing you to be very fearless about making potentially breaking changes.

    • For example, I commit "green to green": Doing TDD, I commit every time I have a newly passing test case. So, assuming I'm in a regular development flow, I'm committing my changes every five minutes or so. Tiny commits, but lots of them. What that means is that if I make a "less than wise choice" at some point, it's trivial to rewind to before I'd made the mistake, potentially keep the throw-away code in another branch while I do my cleanup, and generally use the full power of a revision control system to make my life safer and easier. The branch(es) are pretty chaotic, but that's not a problem because before integrating with the mainline, I take a moment to cleanup: Squash related commits together, write clearer commit messages (since now I know what "the answer" is), and generally move from my drafts to a more finished result. (See below on objections related to "lying with rebase.") That may just be me, though, because I'm very paranoid when it comes to computers. I tend to automatically hit Cmd/Ctl-S every time I type a period when I'm writing, or when I close a block when I'm programming. I have a minimum of three copies/backups around the world of all my important documents. And I "git sync" frequently to make sure my machine isn't the only place where all my hard work is being stored. Have I mentioned I don't trust computers?
  • Branches allow for focused collaboration. Because a branch is about exactly one thing, it means that a team can collaborate around a feature/bug (especially when used in conjunction with a "pull request"), and keep such changes sandboxed until such time that they are ready to bring a larger audience into the mix.

    • Branches encourage being less "shy" about your code. I have heard, on a number of occasions, developers say "I'm not ready to push this to the server yet because [it's still rough (and embarrassing)]/[it may break other people]/etc." All of those reasons for "hoarding" code are moot with branches.

Jez Humble, a brilliant Principle at ThoughtWorks Studios, talks a lot about how "branches are evil." Unfortunately, people hear that, know how smart he is, and simply repeat it without really understanding what his objections are. Fortunately, he posted clarification about what's really meant by that. He essentially says that the problem is that developers abuse branches by not merging with mainline (i.e., "master") on a regular basis. Not constantly getting changes from mainline makes life rough when it comes time to integrate. Not putting your changes into mainline means that your changes are not being validated (via Continuous Integration, or -- better -- with Continuous Delivery). Both are, in fact, sins akin to not doing automated testing.

Making it "easier to do things right than wrong" (i.e., using branches and keeping them synced with mainline) was the primary motivation for this project. Every command here is focussed on making it trivial to use branches that stay in sync with mainline and encourage collaboration.

Q: Why so much emphasis on rebasing? Isn't rebasing a dangerous lie?

Like any powerful tool, "git rebase" is "dangerous" if used incorrectly, just like "rm"/"del". You simply need to know when and how to use it safely. And in the world of version control systems, "rebasing" is easily one of the most useful tools to come around since the "commit" command.

A famous article that people have been parroting in various forms for a while makes the case that rebasing (and its various forms, such as squashing, amending commits, etc.) is a "lie." As with so many things, context is everything.

You almost certainly should not rebase things that you have "published." Generally this really means "Don't rebase the 'master' branch!" Fortunately, these scripts make it impossible to rebase the mainline by accident.

Rebasing "your" code is an extremely useful way of communicating clearly. In the "green to green" scenario above about branches, a lot of noise is generated. If someone wants to review my code, or cherry-pick in my changes, it's too much of a mess to effectively do so. Also, as part of the process of squashing, I have the opportunity to write clearer commit message based upon my newly enhanced understanding. The intermediate commits were my "drafts" and I'm now submitting my cleaned up copy.

If you have ever seen an "active" project that uses a process like "git-flow" that encourages a lot of branching and merging, you've seen how hard it can be to follow a particular line of development. Branch lines are flying around everywhere, and half the commits are pretty much pure noise. (e.g., "Merge branch 'master' of ... into master".) It's also hard to follow the order in which commits actually impacted the mainline. In many ways, in practice merges turn into "a truth effectively being a lie" (because it's buried in the noise) versus rebases that are "a lie (changed from it's 'original' form) to tell an effective truth" (clean and very clear about its impact).

One significant advantage of using automation like this is that it lets you have the best of both worlds. For example, "git sync" uses "rebase" instead of "merge" in a way to is completely safe for collaboration on the same branch. As long as the other people are also using "git sync", it will make sure that changes are automatically incorporated with and brought in line. (See the extensive test suite in "sync_spec.rb" if you want to see how this works.)

This project is trying to promote clear communication about reality as it applies to the code, over micro-management over no-longer-relevant history. Thus rational for the judicious use of rebase.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Something went wrong with that request. Please try again.