git-scripts 0.1.0

data/COPYING

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2012-2013 iFixit
+ 
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+ 
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,124 @@
+# Git Scripts
+
+User scripts for easily managing feature branches and hotfixes.
+
+## Installation
+```bash
+gem install git-scripts
+```
+
+or
+
+```bash
+git clone git://github.com/iFixit/git-scripts.git
+cd git-scripts
+bundle install
+ln -s ${PWD}/bin/feature /path/to/bin/dir/
+ln -s ${PWD}/bin/hotfix /path/to/bin/dir/
+```
+
+## Branching Model
+
+This is loosely based on the [Git Flow][gitflow] branching model, with a couple
+of noteable changes. Essentially Git Flow's `develop` is our `master`, Git
+Flow's `master` is our `stable`, and there are no `release` branches and our
+`hotfix` branch names all have a prefix.
+
+**master** is the active development branch, and what our development server
+has checked out. This is configurable using: `git config
+feature.development_branch branch-name`
+
+**stable** is the branch which is deployed on the production machines. You
+should always be able to check out this branch and get "bug-free" production
+code.  This branch is always ready-to-go and should always be deployed as soon
+as it's changed
+
+**feature branches** are named after the feature you're developing and branched
+from `master`. When finished, the feature branch is merged back into master
+with `--no-ff` (so we preserve the merge commit) and deleted.
+
+**hotfix branches** are named `hotfix-name` and branched from `stable`. When
+finished, the hotfix branch is merged back into `stable` with `--no-ff` so we
+preserve the merge commit. We attempt to merge it back into `master` as well,
+but if it's going to get messy just bail.
+
+## Deployment
+
+The production machines always run off the `stable` branch. When deploying,
+you need to:
+
+* Merge `stable` into `master` (and vice-versa). This ensures that the two code
+  paths come together relatively frequently. This also guarantees that we'll
+  pick up any stray hotfixes that didn't get merged back.
+
+* Create a tag on `stable` for keeping track of deploys
+
+## feature script
+
+    feature <command> [branch name]
+
+Automates some of the git commands for dealing with feature branches. Any
+command that is run with missing arguments will just print the help and exit.
+Any command that modifies the working dir should warn the user and exit(1) if
+the working tree is dirty; automatically managing the stash is frought with
+danger.
+
+    feature start my-awesome-thing
+
+If the branch `my-awesome-thing` does not exist, a new feature branch
+from `master` will be created after a confirmation, and runs a
+`git checkout my-awesome-thing` to drop you on the new branch.
+
+    feature switch your-neato-thing
+
+Assuming the branch `your-neato-thing` exists, it checks out that branch and
+informs you about any stashes saved on that branch.
+
+    feature finish [your-neato-thing]
+
+Creates a pull-request on Github for the current or specified feature branch.
+
+    feature merge [your-neato-thing]
+
+Merges the feature branch back in to `master`, using `--no-ff` to ensure it's a
+non-fast-forward merge. This attempts to get a pull request description from
+the github API.
+
+    feature status
+
+Shows a graphical commit log of the history between the current branch and the
+remote version of the current branch (the upstream).
+
+    feature stashes
+
+Lists the stashes saved on the current branch if any. -v shows all stashes on
+all branches.
+
+## hotfix script
+
+    hotfix <command> [branch name]
+
+Automates the process of fixing a bug on the live site, similar to the
+`feature` script with a few differences. Any command that is run with missing
+arguments will just print the help and exit
+
+    hotfix start my-sweet-fix
+
+Makes a new branch from `stable` named `hotfix_my-sweet-fix`. Prepending the
+name with `hotfix_` allows easy filtering.
+
+    hotfix switch my-other-fix
+
+Switches hotfix branches. Assuming the branch `hotfix_my-other-fix` exists, it
+checks out that branch and informs you about any stashes saved on that branch.
+
+    hotfix finish [my-other-fix]
+
+Creates a pull-request on Github for the current or specified hotfix branch.
+
+    hotfix merge [my-other-fix]
+
+Merges the hotfix branch back into `stable` with `--no-ff`. Also does a
+merge back into `master`.
+
+[gitflow]: http://nvie.com/posts/a-successful-git-branching-model/

data/Rakefile

@@ -0,0 +1,35 @@
+require 'mg'
+MG.new 'git-scripts.gemspec'
+
+desc 'Build the manual'
+task :man do
+  require 'ronn'
+  ENV['RONN_ORGANIZATION'] = 'iFixit'
+  sh "ronn -w -s toc -r5 --markdown man/*.ronn"
+end
+
+desc 'Publish to github pages'
+task :pages => :man do
+  puts '----------------------------------------------'
+  puts 'Rebuilding pages ...'
+  verbose(false) {
+    rm_rf 'pages'
+    push_url = `git remote show origin`.each_line.grep(/Push.*URL/).first[/git@.*/]
+    sh "
+      set -ex
+      git fetch -q origin
+      rev=$(git rev-parse origin/gh-pages)
+      git clone -q -b gh-pages . pages
+      cd pages
+      git reset --hard $rev
+      rm -f *
+      cp -rp ../man/*.html ../man/index.txt ./
+      git add -A .
+      git commit -m 'Rebuild manual.'
+      git push #{push_url} gh-pages
+      cd ..
+      rm -rf pages
+    ", :verbose => false
+  }
+end
+

data/bash_completion.sh

@@ -0,0 +1,33 @@
+#!/bin/sh
+
+_git-scripts()
+{
+   local cmd="${1##*/}"
+   local cur=${COMP_WORDS[COMP_CWORD]}
+   local line=${COMP_LINE}
+
+   # Check to see what command is being executed.
+   case "$cmd" in
+   feature)
+      if [ "$line" = "$cmd $cur" ]; then
+         words="switch start finish stashes list merge pull status clean"
+      else
+         # get branch names minus hotfixes
+         words="$(git branch -a | tr -d ' *' | grep -v 'hotfix-' | sed 's|remotes/origin/||')"
+      fi
+      ;;
+   hotfix)
+      if [ "$line" = "$cmd $cur" ]; then
+         words="switch start finish merge list clean"
+      else
+         # get hotfix branch names
+         words="$(git branch -a | tr -d ' *' | grep 'hotfix-' | sed -e 's|remotes/origin/||' -e 's|hotfix-||')"
+      fi
+      ;;
+   esac
+
+   COMPREPLY=($(compgen -W "${words}" -- ${cur}))
+   return 0
+}
+
+complete -F _git-scripts feature hotfix

data/bin/feature

@@ -0,0 +1,191 @@
+#!/usr/bin/env ruby
+require_relative '../lib/github.rb'
+require_relative '../lib/git.rb'
+require_relative '../lib/helpers.rb'
+
+command=ARGV.first
+
+case command
+when 'github-test'
+   octokit = Github::api
+   # Should succeed if authentication is setup.
+   octokit.pulls(Github::get_github_repo)
+   puts "[Successfully Authenticated]"
+
+when 'start'
+   require_argument(:feature, :start)
+   feature = ARGV[1]
+
+   exit if !confirm("Create feature branch named: '#{feature}' ?")
+
+   Git::run_safe("git checkout #{Git::development_branch}")
+   Git::run_safe("git pull --rebase")
+   Git::run_safe("git branch \"#{feature}\" #{Git::development_branch}")
+   Git::run_safe("git checkout \"#{feature}\"")
+
+   Git::submodules_update
+
+   # Automatically setup remote tracking branch
+   Git::run_safe("git config branch.#{feature}.remote origin")
+   Git::run_safe("git config branch.#{feature}.merge refs/heads/#{feature}")
+   Git::run_safe("git config branch.#{feature}.rebase true")
+
+   puts "Successfully created a new feature-branch: #{feature}"
+
+when 'status'
+   current = Git::current_branch
+   Git::run_safe("git fetch")
+
+   upstream = `git rev-parse --verify --quiet #{current}@{upstream} 2>/dev/null`.strip
+   if upstream == ''
+      die "Your branch #{current} hasn't been pushed"
+   end
+
+   git_command = 'git log --graph --boundary --color=always --decorate --date-order'
+   incoming = `#{git_command} #{current}..#{upstream}`.strip
+   outgoing = `#{git_command} #{upstream}..#{current}`.strip
+   incoming = nil if incoming == ''
+   outgoing = nil if outgoing == ''
+
+   if (incoming && outgoing)
+      # Show the whole history graph (... == through common ancestor)
+      puts `#{git_command} #{upstream}...#{current}`.strip
+      puts HIGHLIGHT
+      puts "Your branch has diverged from the remote branch"
+   elsif incoming
+      puts incoming
+      puts HIGHLIGHT
+      puts "Your branch is behind the remote branch"
+   elsif outgoing
+      puts outgoing
+      puts HIGHLIGHT
+      puts "Your branch is ahead of the remote branch"
+   else
+      puts HIGHLIGHT
+      puts "Your branch is up to date"
+   end
+   print HIGHLIGHT_OFF
+
+
+when 'finish'
+   feature = ARGV[1] || Git::current_branch
+   # Push commits to origin
+   Git::run_safe("git push origin #{feature}:#{feature}")
+
+   exit 1 if !confirm("Create a pull-request for feature branch named: '#{feature}' ?")
+   octokit = Github::api
+
+   description = Github::get_pull_request_description(feature)
+   puts "Pull-request description:"
+   puts description[:title]
+   puts "#"
+   puts description[:body]
+
+   response = octokit.create_pull_request(
+      Github::get_github_repo,
+      Git::development_branch,
+      feature,
+      description[:title],
+      description[:body]
+   )
+
+   puts "Successfully created pull-request ##{response[:number]}"
+   puts "   " + response[:html_url]
+
+when 'merge'
+   dev_branch = Git::development_branch
+   fail_on_local_changes
+   Git::run_safe("git fetch")
+
+   feature = ARGV[1] || Git::current_branch
+
+   exit 1 if !confirm("Merge feature branch named: '#{feature}' ?")
+
+   description = Github::get_pull_request_description_from_api(feature, dev_branch)
+
+   # Checkout the branch first to make sure we have it locally.
+   Git::run_safe("git fetch")
+   Git::run_safe("git checkout \"#{feature}\"")
+
+   Git::run_safe("git rebase --preserve-merges origin/#{feature}")
+
+   # pull the latest changes from master
+   Git::run_safe("git checkout #{dev_branch}")
+
+   # rebase the unpushed master commits if any.
+   Git::run_safe("git rebase --preserve-merges origin/#{dev_branch}")
+
+   # merge the feature branch into master
+   Git::run_safe("git merge --no-ff --edit -m #{description.shellescape} \"#{feature}\"")
+
+   # init any submodules in the master branch
+   Git::submodules_update
+
+   # delete the local feature-branch
+   Git::run_safe("git branch -d \"#{feature}\"")
+
+   # delete the remote branch we'll leave this off for now
+   # Git::run_safe("git push origin :\"#{feature}\"")
+   # push the the merge to our origin
+   # Git::run_safe("git push origin")
+
+   puts
+   puts "Successfully merged feature-branch: #{feature} into #{dev_branch}"
+
+when 'switch'
+   require_argument(:feature, :switch, min=2, max=3)
+   feature = ARGV[1]
+
+   Git::switch_branch(feature)
+
+when 'clean'
+   args = ''
+
+   # Remove all untracked .gitignored files as well
+   args += 'x' if ARGV.include?('--all')
+
+   # -fd alone will NOT remove submodule directories, -ffd is required for this
+   Git::run_safe("git clean -ffd#{args}")
+
+when 'pull'
+   Git::run_safe("git fetch")
+
+   current = Git::current_branch
+   upstream = "#{current}@{upstream}"
+   upstream_hash = Git::branch_hash(upstream)
+
+   if upstream_hash == ''
+      die "Your branch #{current} hasn't been pushed, nothing to pull from"
+   end
+
+   old_branch_hash = Git::branch_hash(current)
+   Git::run_safe("git rebase --preserve-merges origin/#{current}")
+
+   Git::submodules_update
+
+   if Git::branch_hash(current) == old_branch_hash
+      die "No changes in the remote branch. Your branch is up to date."
+   end
+
+when 'list'
+   options = {
+      :feature => Git::feature_branches(:unmerged)
+   }
+   if ARGV.include?('-v')
+      options[:merged] = Git::feature_branches(:merged)
+   end
+   Git.show_branch_list(options)
+
+when 'stashes'
+   current_branch = nil
+
+   if !ARGV.include?('-v')
+      current_branch = Git::current_branch
+   end
+
+   Git::show_stashes_saved_on(current_branch)
+
+else
+   display_feature_help
+end
+

data/bin/hotfix

@@ -0,0 +1,142 @@
+#!/usr/bin/env ruby
+require_relative '../lib/github.rb'
+require_relative '../lib/git.rb'
+require_relative '../lib/helpers.rb'
+
+command=ARGV.first
+BRANCH_PREFIX = "hotfix-"
+case command
+when 'start'
+   require_argument(:hotfix, :start)
+   hotfix = BRANCH_PREFIX + ARGV[1]
+
+   exit if !confirm("Create hotfix branch named: '#{hotfix}' ?")
+
+   Git::run_safe("git checkout stable")
+   Git::run_safe("git pull --rebase")
+   Git::run_safe("git branch \"#{hotfix}\" stable")
+   Git::run_safe("git checkout \"#{hotfix}\"")
+
+   Git::submodules_update
+
+   # Automatically setup remote tracking branch
+   Git::run_safe("git config branch.#{hotfix}.remote origin")
+   Git::run_safe("git config branch.#{hotfix}.merge refs/heads/#{hotfix}")
+   Git::run_safe("git config branch.#{hotfix}.rebase true")
+
+when 'switch'
+   require_argument(:hotfix, :switch, min=2, max=3)
+   hotfix = BRANCH_PREFIX + ARGV[1]
+
+   Git::switch_branch(hotfix)
+
+when 'finish'
+   hotfix = ARGV[1] || Git::current_branch
+
+   # ensure the hotfix name is the real branch name
+   if (!hotfix.start_with?("hotfix-"))
+       hotfix = "hotfix-" + hotfix
+   end
+
+   # Push commits to origin
+   Git::run_safe("git push origin #{hotfix}:#{hotfix}")
+
+   exit 1 if !confirm("Create a pull-request for hotfix branch named: '#{hotfix}' ?")
+   octokit = Github::api
+
+   description = Github::get_pull_request_description(hotfix)
+   puts "Pull-request description:"
+   puts description[:title]
+   puts "#"
+   puts description[:body]
+
+   response = octokit.create_pull_request(
+      Github::get_github_repo,
+      'stable',
+      hotfix,
+      description[:title],
+      description[:body]
+   )
+
+   puts "Successfully created pull-request ##{response[:number]}"
+   puts "   " + response[:html_url]
+
+when 'merge'
+   fail_on_local_changes
+   dev_branch = Git::development_branch
+
+   Git::run_safe("git fetch")
+
+   if ARGV[1]
+      hotfix = BRANCH_PREFIX + ARGV[1]
+   else
+      hotfix = Git::current_branch
+   end
+
+   exit 1 if !confirm("Merge hotfix named: '#{hotfix}' ?")
+
+   description = Github::get_pull_request_description_from_api(hotfix, 'stable')
+
+   # Checkout the branch to make sure we have it locally.
+   Git::run_safe("git checkout \"#{hotfix}\"")
+   Git::run_safe("git rebase --preserve-merges origin/#{hotfix}")
+
+   # Merge into stable
+   Git::run_safe("git checkout stable")
+
+   # pull the latest changes and rebase the unpushed commits if any.
+   Git::run_safe("git rebase --preserve-merges origin/stable")
+
+   # merge the hotfix branch into stable
+   Git::run_safe("git merge --no-ff --edit -m #{description.shellescape} \"#{hotfix}\"")
+
+   # init any submodules in the stable branch
+   Git::submodules_update
+   # push the the merge to our origin
+   # Git::run_safe("git push origin")
+
+   description = Github::get_pull_request_description_from_api(hotfix, dev_branch)
+
+   # Merge into master
+   Git::run_safe("git checkout #{dev_branch}")
+
+   # pull the latest changes and rebase the unpushed master commits if any.
+   Git::run_safe("git rebase origin/#{dev_branch}")
+
+   # merge the hotfix branch into master
+   Git::run_safe("git merge --no-ff --edit -m #{description.shellescape} \"#{hotfix}\"")
+
+   # init any submodules in the master branch. Note: no need to change
+   # directories before calling git submodule since we are already in the
+   # projects top-level directory
+   Git::submodules_update
+
+   # push the the merge to our origin
+   # Git::run_safe("git push origin")
+
+   # delete the local hotfix branch
+   Git::run_safe("git branch -d \"#{hotfix}\"")
+   # delete the remote hotfix branch -- we'll leave this off for now
+   # Git::run_safe("git push origin :\"#{hotfix}\"")
+
+   # checkout stable branch
+   Git::run_safe("git checkout stable")
+
+   puts "Successfully merged hotfix branch: #{hotfix} into stable and #{dev_branch}"
+   puts "If you are satisfied with the result, do this:\n" + <<CMDS
+      git push
+      git checkout #{dev_branch}
+      git push
+CMDS
+
+when 'list'
+   options = {
+      :hotfix => Git::hotfix_branches(:unmerged)
+   }
+   if ARGV.include?('-v')
+      options[:merged] = Git::hotfix_branches(:merged)
+   end
+   Git.show_branch_list(options)
+else
+   display_hotfix_help
+end