flash_flow 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a836475713f58f0a511b59b28b404af5d43b20bd
+  data.tar.gz: f301d93bfcab8720f1a9f76b6e60d69fb8da0530
+SHA512:
+  metadata.gz: 57776f50518921b2f3c16407b11bb54cc294d141d11e1936509ecd72d1ee0343ca2931e319561395c68c3eaa644393bd29611d52dd87e7eb3d787f3b3533af04
+  data.tar.gz: e60cd7cb7dcd124dfdb62ee1900f5fae8785e04d02c4179f91f814971ef7e5be32200b6dee1ab88ef539415f3f760027a4e426cd68f3637227e9a9951bfbca0f

data/.gitignore

@@ -0,0 +1,10 @@
+coverage
+/.bundle
+.env
+/log/*.log
+/tmp
+/doc
+public/*
+vendor/bundle
+.DS_Store
+.idea/

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fund_america.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    flash_flow (1.0.0)
+      hipchat
+      octokit
+      pivotal-tracker
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    builder (3.2.2)
+    byebug (3.5.1)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+      slop (~> 3.6)
+    columnize (0.9.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    debugger-linecache (1.2.0)
+    domain_name (0.5.25)
+      unf (>= 0.0.5, < 1.0.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    hipchat (1.5.2)
+      httparty
+      mimemagic
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.3)
+    mime-types (2.6.2)
+    mimemagic (0.3.0)
+    mini_portile (0.6.2)
+    minitest (5.3.5)
+    minitest-stub_any_instance (1.0.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    netrc (0.10.3)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    nokogiri-happymapper (0.5.9)
+      nokogiri (~> 1.5)
+    octokit (4.1.1)
+      sawyer (~> 0.6.0, >= 0.5.3)
+    pivotal-tracker (0.5.13)
+      builder
+      crack
+      nokogiri (>= 1.5.5)
+      nokogiri-happymapper (>= 0.5.4)
+      rest-client (>= 1.8.0)
+    rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    safe_yaml (1.0.4)
+    sawyer (0.6.0)
+      addressable (~> 2.3.5)
+      faraday (~> 0.8, < 0.10)
+    slop (3.6.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  byebug
+  flash_flow!
+  minitest
+  minitest-stub_any_instance
+  rake
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 FlashFunders
+
+MIT License
+
+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,152 @@
+# Flash Flow
+
+Flash Flow is a ruby gem that helps your team keep your acceptance environment up to date. Check out
+[this gist](https://gist.github.com/bradleyjucsc/bfbb8742889edf1b423a) for a detailed explanation of
+how it works.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flash_flow'
+
+And then run:
+
+    $ bundle install
+    $ bundle exec flash_flow --install
+
+Or install it yourself as:
+
+    $ gem install flash_flow
+
+And then run:
+
+    $ flash_flow --install
+
+After "installing" flash_flow, you'll have a file "config/flash_flow.yml.erb". If your remote is origin,
+your master branch is master, and you're fine using "acceptance" as the branch that flash_flow owns, you
+are ready to go for flash_flow basic. If not, edit that file and change branch and remote names accordingly.
+
+## Usage
+flash_flow is a ruby script which, in the simplest case, can just be run by calling `flash_flow`.
+What that will do (once your application is properly configured) is:
+
+1. Push your branch to the `merge_remote`
+2. Reset your `merge_branch` to be the same as your `master_branch`
+3. Get your list of pull requests from github (or use the saved list, more on that later)
+4. Filter out any "removed" branches
+5. Merge the rest into the newly created `merge_branch`
+6. Force push the `merge_branch` to the `merge_remote`
+
+### Notes
+
+1. Step 1 will not push your branch if you're on either the `merge_branch` or `master_branch`, but it will
+still merge all the other branches and push the result.
+2. flash_flow uses your local git repo. It resets everything back to the branch you started in, but you should not do
+anything else in your repo while it's running because lots of mayhem will ensue.
+
+
+### Configuring a lock
+We use the "lock" configuration in flash_flow.yml. The lock ensures that no one else is running flash_flow
+while you are so that you don't inadvertently have your newly pushed branch overwritten. The way we lock you
+out is super janky, we open an issue on github when flash_flow starts and close it when flash_flow is done.
+To configure the lock you need to specify the class name, your github token, your github repo, and the issue_id
+that you want to open and close each time. The email alerts you get from github about this issue are annoying
+and should be ignored.
+
+### Configuring branches
+We use github to track our branches that we want to merge, and there are a few things about that worth noting.
+In step 1 after your branch is pushed, a pull request into `master_branch` will be created on github.  If you
+add the "do not merge" label to a pull request, it will be excluded from the `merge_branch`. This is extremely
+useful whenever one of your co-workers breaks the build, you can either run `flash_flow --no-merge` from their
+branch, or go directly to github and add the "do not merge" label and then re-run flash_flow from your branch.
+To use github as your source of merge branches you have to configure it with the class name, github token and
+repo, your master branch name and both the unmergeable label and do not merge label, which must exist on github.
+The unmergeable label is added to a pull request that has a conflict that can't be resolved and is therefore
+excluded from the merge branch.
+
+### Configuring an issue tracker
+We use Pivotal Tracker. Anytime flash_flow is run, all the branches that get merged, if they have any stories
+associated with them (added via the `--stories` option), those stories will transition to "finished" if they
+were previously "started". When code deploys to our review environment, our deploy script runs
+`flash_flow --review-deploy`, which transitions stories associated with merged branches from "finished" to
+"delivered". At the same time, for a branch that has been removed ("--no-merge"), if the story is "delivered"
+it will transition back to "finished". In addition, as part of our production deploy
+script, we run `flash_flow --prod-deploy`, which takes all the stories that are newly in the `master_branch`
+and adds a comment "Deployed to production on 12/25/2015 at 11:11pm". So using the story option can be handy.
+
+### Configuring hipchat
+When a branch other than the one you're on doesn't merge cleanly and can't be fixed by rerere (more on that later
+too), a notification can go out to Hipchat. The Hipchat notifier needs your token (api v2 token) and the room
+to which the message will be sent.
+
+### Runtime options
+
+#### -n, --no-merge
+Runs flash_flow, but excludes the branch that you're on from the merge branch. If the branch you're on has breaking
+tests, you may want to get it out of your `merge_branch`, and this will do that and ensure that the next times
+flash_flow is run by anyone else it will not be included. It will add the "do not merge" label to your github pull
+request if you're using that. Anytime you run flash_flow without this option, the branch you're running from will
+be included in the `merge_branch` even if it has previously been set to "do not merge".
+
+#### --rerere-forget
+If you've resolved a merge conflict the wrong way, run with this option on the problem branch. The remembered
+resolution will be deleted and you'll get to re-resolve your conflict.
+
+#### --story <story_id>
+Associates a story id with this branch. See "configuring an issue tracker" for why this can be useful.
+
+#### --stories <story_id1,storyid2...>
+Same as --story, but a comma-separated list so you can pass more than one story at a time.
+
+#### -f, --force-push
+Forces pushes your branch. All it does is add "-f" to the git push command, so you'd better make sure you know what
+you're doing if you use this. The `merge_branch` always gets force pushed at the end, this option has nothing to do
+with that.
+
+#### --release-notes <hours>
+Lists all the stories that have been deployed to production in the last <hours> hours. Only relevant if you run
+--prod-deploy when you deploy.
+
+#### --config-file FILE_PATH
+This tells flash_flow how to find the configuration file. If you just put the file in config/flash_flow.yml you will
+never need this option.
+
+#### --prod-deploy
+If you have Pivotal Tracker configured it will look at all stories associated with branches, and if that branch is
+deployed to `master_branch` it will add a comment to those stories that says
+"Deployed to production on MM/DD/YY at XX:XX". This is meant to be used right after every deploy to your production
+environment. The acceptance branch will not be re-built in this case.
+
+#### --review-deploy
+If you have Pivotal Tracker configured it will look at all stories associated with branches, and if that branch is
+deployed to `acceptance_branch` it will mark any finished stories as delivered. This is best used right after every
+deploy to your acceptance environment. The acceptance branch will not be re-built in this case.
+
+### Merge conflicts
+When we first started using flash_flow, if your branch had a merge conflict you were out of luck. You had to wait for
+the branch that you were conflicting with to be merged to master, merge master into your branch, and then try again to
+get your code into the merge branch.
+
+Then we discovered git rerere, which is the coolest feature of git that almost no one seems to have heard of. Googling
+it turns up a few really good resources on how it works, but in one sentence or less what it does is remember how you
+resolved conflicts and apply those patches.
+
+If your branch has a conflict with the `merge_branch` flash_flow will look for a rerere patch and apply that if it
+exists. If it doesn't, flash_flow will not merge your branch (but will continue merging all the others), and it will
+spit out instructions for how to make your branch merge successfully. Once you follow those instructions (which involve
+resolving the merge conflicts and saving the resolution), the next time you run flash_flow it will use that resolution
+and everything will be sunshine and ponies.
+
+In addition, flash_flow takes all your patches and copies them into the `merge_branch` where they are saved. Every time
+flash_flow is run, those patches are first copied out of the `merge_branch` into your local rerere cache. The result of
+this is that every time flash_flow is run all previous resolutions are available so once you've merged your branch and
+flash_flow'ed it, it will merge successfully for everyone else too. rerere ftwftwftw.
+
+## Contributing
+
+1. Fork it ( https://github.com/flashfunders/flash_flow/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb', 'test/**/test*.rb']
+  t.verbose = true
+end
+
+task :default => [:test]

data/bin/flash_flow

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'flash_flow'
+
+options = FlashFlow::Options.parse
+
+if options[:install]
+  FlashFlow::Install.install
+  exit(0)
+end
+
+FlashFlow::Config.configure!(options[:config_file])
+case
+  when options[:prod_deploy]
+    FlashFlow::IssueTracker::Base.new(FlashFlow::Config.configuration.issue_tracker).production_deploy
+  when options[:review_deploy]
+    FlashFlow::IssueTracker::Base.new(FlashFlow::Config.configuration.issue_tracker).stories_delivered
+  when options[:release_notes]
+    FlashFlow::IssueTracker::Base.new(FlashFlow::Config.configuration.issue_tracker).release_notes(options[:release_notes])
+  else
+    FlashFlow::Deploy.new(options).run
+    FlashFlow::IssueTracker::Base.new(FlashFlow::Config.configuration.issue_tracker).stories_pushed
+end

data/flash_flow.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flash_flow/version'
+Gem::Specification.new do |spec|
+  spec.name          = "flash_flow"
+  spec.version       = FlashFlow::VERSION
+  spec.authors       = ["Flashfunders"]
+  spec.email         = ["engineering@flashfunders.com"]
+  spec.summary       = %q{Implementation of the flashfunders workflow}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'octokit'
+  spec.add_dependency 'hipchat'
+  spec.add_dependency 'pivotal-tracker'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency 'minitest-stub_any_instance'
+end

data/flash_flow.yml.erb.example

@@ -0,0 +1,83 @@
+## The basic settings for your app
+
+git:
+  # This is what allows you to resolve merge conflicts using flash_flow, rerere is amazing. There's
+  # more description elsewhere about how this works.
+  use_rerere: true
+
+  # Which remote to push the merge branch to
+  merge_remote: origin
+
+  # This branch is owned by flash_flow, it force pushes every time. So don't use a branch to which you make
+  # commits. Treat this as 100% ephemeral, but if you can you should deploy it automatically to your
+  # review/staging env when it gets pushed.
+  merge_branch: acceptance
+
+  # This is your mainline production branch that is the basis for the merge branch
+  master_branch: master
+
+# An arbitrary file that flash_flow will write to in the merge branch and use to store branch information.
+# Make sure it doesn't collide with a file you actually need in your application. You don't need to look at
+# this file in general.
+branch_info_file: 'your/random/file'
+
+
+
+### Everything below here is optional and should be deleted or remain commented out if you don't need it
+
+
+## This will send merge conflict notifications to the hipchat room configured below, only for branches
+## other than your own.
+
+#notifier:
+#  class:
+#    name: 'FlashFlow::Notifier::Hipchat'
+#    token: <%= ENV['HIPCHAT_TOKEN'] %>
+#    room: 'Flash Flow Notifications'
+
+
+## If you use Pivotal Tracker, this integration can finish, deliver, un-deliver, and comment when
+## deployed to production if you set it up.
+## Must be used in conjuction with the "--story or --stories" options.
+## You need to run "flash_flow --review-deploy" when you deploy to your review enviroment to get the
+## deliver/un-deliver functionality.
+## You need to run "flash_flow --prod-deploy" when you deploy to production to get the "Deployed to production"
+## The timezone attribute will be set to system time zone (TZ environment variable).
+## comment when your story is deployed to prod.
+
+#issue_tracker:
+#  class:
+#    name: 'FlashFlow::IssueTracker::Pivotal'
+#    token: <%= ENV['TRACKER_TOKEN'] %>
+#    project_id: # Your Pivotal project id goes here
+#    timezone: 'US/Pacific'
+
+
+## We use this to ensure only one person at a time runs flash_flow. It checks the github issue when
+## flash_flow starts, and if it's open flash_flow exits. Otherwise it opens the issue (thus locking
+## other users out) and then closes it when flash_flow is done with its work. Using github in this way
+## is weird, and not a 100% reliable lock, but it at least prevents most possible cases of odd
+## concurrency issues.
+
+#lock:
+#  class:
+#    name: 'FlashFlow::Lock::Github'
+#    token: <%= ENV['GH_TOKEN'] %>
+#    repo: # Your github repo. For example, the flash_flow repo is 'flashfunders/flash_flow'
+#    issue_id: # Your github issue id goes here
+
+
+## We use Github as our source of truth for which branches to merge. All open pull requests that don't
+## have the "do not merge" label on them get merged. If you configure this flash_flow will automatically
+## create a PR for your branch when it runs. If your branch can't merge, it will still be PR'ed, but it
+## will have the "unmergeable" label on it (that label is strictly informational, no functionality is
+## affected at all).
+
+#branches:
+#  class:
+#    name: 'FlashFlow::Data::Github'
+#    token: <%= ENV['GH_TOKEN'] %>
+#    repo: # Your github repo. For example, the flash_flow repo is 'flashfunders/flash_flow'
+#    master_branch: master
+#    unmergeable_label: unmergeable
+#    do_not_merge_label: 'do not merge'

data/lib/flash_flow.rb

@@ -0,0 +1,7 @@
+module FlashFlow; end
+
+require 'flash_flow/options'
+require 'flash_flow/install'
+require 'flash_flow/config'
+require 'flash_flow/deploy'
+require 'flash_flow/issue_tracker'