sleet 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36ddaacead84e702849b36dd91308e7028782d3775e91937054e6d2d54632554
-  data.tar.gz: ac73e5669a06f891cc250e3c2c67d27ce38c4d9d8b72b44233cec204c4086ef4
+  metadata.gz: 54355bc21cd53356e769f7bc10c5ac14ae2c0c332203e1194ee4588c40ebe475
+  data.tar.gz: b4d029da2f74a94712edcd0cde780f8e4029c844be8461a544d589c40072a6d9
 SHA512:
-  metadata.gz: 24ae81f4d3265a67c3a7ee272ea5aefdb7df57fcd930e584aba4a34290c20ff16cc2fd779c5be25329e8f3cd9e2e4301cd209d478a0dd4900af9f946634b4d44
-  data.tar.gz: eea0a055ba465999874d97ca5493b148c02039e6908d8eb75993cc7c9403afdaf5f65c2df099cf7e1ce0342c827f87b1616d39084449cff77fc385ab3a3c2a9e
+  metadata.gz: 7d9c5d7d4d8ac342de5a1abc280ed46da05cb72680f4973c9351eb277f87f89756a82bac6ff6c2fdfcd070f54ea39fc8b819f49946e13ea0f7592db8c2451fb9
+  data.tar.gz: '0190c0ffb1e5cc760fbe024920a1b892fc05185ab61a9633580829739c0308f217394a68509df8dd846474a5593ba51fd68d8e60b7c9879fb6f41c2873be891e'

data/.circleci/config.yml

@@ -8,23 +8,8 @@ jobs:
     steps:
       - checkout
 
-      - run: date +%U-%Y > 'date-cache-key.txt'
-      - run: ruby -v > 'ruby-version.txt'
-
-      ## Bundler
-      # Restore Cache
-      - restore_cache:
-          keys:
-            - gem-cache-{{ checksum "ruby-version.txt" }}-{{ checksum "sleet.gemspec" }}-
-            - gem-cache-{{ checksum "ruby-version.txt" }}-
-            - gem-cache-
       # Install
       - run: bundle check --path vendor/bundle || sudo apt-get install cmake && bundle install --path vendor/bundle
-      # Store Cache
-      - save_cache:
-          key: gem-cache-{{ checksum "ruby-version.txt" }}-{{ checksum "sleet.gemspec" }}-{{ checksum "date-cache-key.txt" }}
-          paths:
-            - vendor/bundle
 
       - type: shell
         command: |
@@ -35,7 +20,7 @@ jobs:
             --out /tmp/test-results/rubocop.xml \
             --format progress \
             --force-exclusion \
-            $(bundle exec rubocop --list-target-files | circleci tests split --split-by=filesize --show-counts)
+            $(circleci tests glob "**/*.rb" | circleci tests split --split-by=filesize --show-counts)
 
       # Run rspec in parallel
       - type: shell

data/.gitignore

@@ -12,3 +12,5 @@
 
 # Ignore Rspec Example Status File
 spec/.rspec_example_statuses
+
+.envrc

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Change Log
 
+## [v0.4.2](https://github.com/coreyja/sleet/tree/v0.4.2) (2019-05-26)
+[Full Changelog](https://github.com/coreyja/sleet/compare/v0.4.1...v0.4.2)
+
+**Closed issues:**
+
+- Dependabot can't resolve your Ruby dependency files [\#51](https://github.com/coreyja/sleet/issues/51)
+- Dependabot can't resolve your Ruby dependency files [\#50](https://github.com/coreyja/sleet/issues/50)
+- Dependabot can't resolve your Ruby dependency files [\#48](https://github.com/coreyja/sleet/issues/48)
+- Dependabot can't resolve your Ruby dependency files [\#49](https://github.com/coreyja/sleet/issues/49)
+
+**Merged pull requests:**
+
+- Fix CircleCI Builds [\#59](https://github.com/coreyja/sleet/pull/59) ([coreyja](https://github.com/coreyja))
+- Add a Gitter chat badge to README.md [\#58](https://github.com/coreyja/sleet/pull/58) ([gitter-badger](https://github.com/gitter-badger))
+- Symlink to docs README.md from top level [\#57](https://github.com/coreyja/sleet/pull/57) ([coreyja](https://github.com/coreyja))
+- Docs site fixes [\#56](https://github.com/coreyja/sleet/pull/56) ([coreyja](https://github.com/coreyja))
+- Setup Github Pages [\#54](https://github.com/coreyja/sleet/pull/54) ([coreyja](https://github.com/coreyja))
+- Update rugged requirement from \>= 0.26, \< 0.28 to \>= 0.26, \< 0.29 [\#53](https://github.com/coreyja/sleet/pull/53) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Remove direct dependency on Bundler [\#52](https://github.com/coreyja/sleet/pull/52) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update webmock requirement from ~\> 3.4.0 to ~\> 3.5.1 [\#47](https://github.com/coreyja/sleet/pull/47) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+
 ## [v0.4.1](https://github.com/coreyja/sleet/tree/v0.4.1) (2018-11-24)
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.4.0...v0.4.1)
 
@@ -7,12 +28,12 @@
 
 - chore: Set up Rubocop-Coreyja gem [\#45](https://github.com/coreyja/sleet/pull/45) ([coreyja](https://github.com/coreyja))
 - Update README.md [\#40](https://github.com/coreyja/sleet/pull/40) ([coreyja](https://github.com/coreyja))
-- Update gem-release requirement to = 2.0.1 [\#33](https://github.com/coreyja/sleet/pull/33) ([dependabot[bot]](https://github.com/apps/dependabot))
-- Update webmock requirement to ~\> 3.4.0 [\#28](https://github.com/coreyja/sleet/pull/28) ([dependabot[bot]](https://github.com/apps/dependabot))
-- Update faraday requirement to \>= 0.13.1, \< 0.16.0 [\#27](https://github.com/coreyja/sleet/pull/27) ([dependabot[bot]](https://github.com/apps/dependabot))
-- Update rubocop requirement to ~\> 0.55.0 [\#26](https://github.com/coreyja/sleet/pull/26) ([dependabot[bot]](https://github.com/apps/dependabot))
-- Update gem-release requirement to = 2.0.0.rc.3 [\#25](https://github.com/coreyja/sleet/pull/25) ([dependabot[bot]](https://github.com/apps/dependabot))
-- Update rugged requirement to \>= 0.26, \< 0.28 [\#24](https://github.com/coreyja/sleet/pull/24) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Update gem-release requirement to = 2.0.1 [\#33](https://github.com/coreyja/sleet/pull/33) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update webmock requirement to ~\> 3.4.0 [\#28](https://github.com/coreyja/sleet/pull/28) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update faraday requirement to \>= 0.13.1, \< 0.16.0 [\#27](https://github.com/coreyja/sleet/pull/27) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update rubocop requirement to ~\> 0.55.0 [\#26](https://github.com/coreyja/sleet/pull/26) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update gem-release requirement to = 2.0.0.rc.3 [\#25](https://github.com/coreyja/sleet/pull/25) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update rugged requirement to \>= 0.26, \< 0.28 [\#24](https://github.com/coreyja/sleet/pull/24) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
 
 ## [v0.4.0](https://github.com/coreyja/sleet/tree/v0.4.0) (2018-03-08)
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.10...v0.4.0)
@@ -31,7 +52,7 @@
 **Merged pull requests:**
 
 - Base Version Option [\#20](https://github.com/coreyja/sleet/pull/20) ([coreyja](https://github.com/coreyja))
-- Update rubocop requirement to ~\> 0.53.0 [\#19](https://github.com/coreyja/sleet/pull/19) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Update rubocop requirement to ~\> 0.53.0 [\#19](https://github.com/coreyja/sleet/pull/19) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
 
 ## [v0.3.9](https://github.com/coreyja/sleet/tree/v0.3.9) (2018-03-04)
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.8...v0.3.9)
@@ -43,8 +64,8 @@
 **Merged pull requests:**
 
 - Refactor [\#18](https://github.com/coreyja/sleet/pull/18) ([coreyja](https://github.com/coreyja))
-- Update rake requirement to ~\> 12.3 [\#17](https://github.com/coreyja/sleet/pull/17) ([dependabot[bot]](https://github.com/apps/dependabot))
-- Update faraday requirement to \>= 0.13.1, \< 0.15.0 [\#16](https://github.com/coreyja/sleet/pull/16) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Update rake requirement to ~\> 12.3 [\#17](https://github.com/coreyja/sleet/pull/17) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update faraday requirement to \>= 0.13.1, \< 0.15.0 [\#16](https://github.com/coreyja/sleet/pull/16) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
 
 ## [v0.3.8](https://github.com/coreyja/sleet/tree/v0.3.8) (2018-02-25)
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.7...v0.3.8)

data/README.md

@@ -0,0 +1 @@
+./docs/README.md

data/docs/CNAME

@@ -0,0 +1 @@
+sleet.dev

data/docs/README.md

@@ -0,0 +1,143 @@
+# Sleet ☁️ ❄️
+
+[![Gem Version](https://badge.fury.io/rb/sleet.svg)](https://badge.fury.io/rb/sleet)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7f346b368d72b53ef630/maintainability)](https://codeclimate.com/github/coreyja/sleet/maintainability)
+[![CircleCI](https://circleci.com/gh/coreyja/sleet.svg?style=svg)](https://circleci.com/gh/coreyja/sleet)
+[![Join the chat at https://gitter.im/rspec-sleet/community](https://badges.gitter.im/rspec-sleet/community.svg)](https://gitter.im/rspec-sleet/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+## Background and Problem
+
+RSpec has a [feature](https://relishapp.com/rspec/rspec-core/v/3-7/docs/command-line/only-failures) that I find very useful which is the `--only-failures` option. This will re-run only that examples that failed the previous run.
+
+CircleCI has support for [uploading artifcats](https://circleci.com/docs/2.0/artifacts/) with your builds, which allows us to store the persistance file that powers the RSpec only failures option.
+However! CircleCI also supports and encourages parallelizing your build, which means even if you upload your rspec persistance file, you actually have a number of them each containing a subset of your test suite.
+This is where `Sleet` comes in!
+
+## Purpose
+
+This tool does two things:
+1. It downloads all of the `.rspec_failed_examples` files that were uploaded to CircleCI for the most recent build of the current branch
+2. It combines the multiple files into a single sorted `.rspec_failed_examples` file, and moves it to the [current directory](https://github.com/coreyja/CRSPFA/issues/1)
+
+## Getting Started
+
+### 1. Configure RSpec to Create and Use an example persistance file
+
+We need to set the `example_status_persistence_file_path` config in RSpec. Here are the relevant [RSpec docs](https://relishapp.com/rspec/rspec-core/v/3-7/docs/command-line/only-failures#background).
+
+The first step is to create(/or add to) your `spec/spec_helper.rb` file. We want to include the following configuration, which tells RSpec where to store the status persistance file. The actual location and file name are up to you, this is just an example. (Though using this name will require less configuration later.)
+
+```
+RSpec.configure do |c|
+  c.example_status_persistence_file_path = ".rspec_example_statuses"
+end
+```
+
+if you just created the `spec_helper.rb` file then you will need to create a `.rspec` file containing the following to load your new helper file.
+
+```
+--require spec_helper
+```
+
+Again there are other ways to load your `spec_helper.rb` file, including requiring it from each spec. Pick one that works for you.
+
+### 2. Collect the example persistance files in CircleCI
+
+To do this we need to create a step which [saves](https://circleci.com/docs/2.0/artifacts/) the `.rspec_example_statuses` as artifacts of the build. The following is an example of such a step in CircleCI. This must happen after rspec has run or else the persistance file will not exist.
+
+```
+- store_artifacts:
+    path: .rspec_example_statuses
+
+```
+
+### 3. Save a CircleCI Token locally (to access private builds)
+
+In order to see private builds/repos in CircleCI you will need to get a CircleCI token and save it locally to a Sleet Configuration file.
+The recommended approach is to create a yml file in your home directory which contains your the key `circle_ci_token`
+
+```
+circle_ci_token: PLACE_TOKEN_HERE
+```
+
+An API token can be generated here: [https://circleci.com/account/api](https://circleci.com/account/api)
+
+### 4. Run this tool from your project
+
+```
+sleet
+```
+
+This will look up the latest completed build in CircleCI for this branch, and download all the relevant `.rspec_example_statuses` files. It then combines and sorts them and saves the result to the `.rspec_example_statuses` file locally.
+
+### 5. Run RSpec with `--only-failures`
+
+```
+bundle exec rspec --only-failures
+```
+
+This will run only the examples that failed in CircleCI!
+
+## Configuration
+
+If you are using Worklfows in your CircleCI builds, or you are working with a different persistance file name, you may need to configure Sleet beyond the defaults.
+
+Sleet currently supports two ways to input configurations:
+
+1. Through YML files
+    - `Sleet` will search 'up' from where the command was run and look for `.sleet.yml` files. It will combine all the files it finds, such that 'deeper' files take presedence. This allows you to have a user-level config at `~/.sleet.yml` and have project specific files which take presendence over the user level config (ex: `~/Projects/foo/.sleet.yml`)
+2. Through the CLI
+    - These always take presendece the options provided in the YML files
+
+To view your current configuration use the `sleet config` command which will give you a table of the current configuration. You can also use the `--print-config` flag with the `fetch` command to print out the config, including any other CLI options. This can be useful for bebugging as the output also tells you where each option came from.
+
+### Options
+
+These are the options that are currently supported
+
+#### `source_dir`
+
+Alias: s
+
+This is the directory of the source git repo. If a `source_dir` is NOT given we look up from the current directory for the nearest git repo.
+
+#### `input_file`
+
+Alias: i
+
+This is the name of the Rspec Circle Persistance File in CircleCI. The default is `.rspec_example_statuses`
+
+This will match if the full path on CircleCI ends in the given name.
+
+#### `output_file`
+
+Alias: o
+
+This is the name for the output file, on your local system. It is relative to the `source_dir`.
+
+Will be IGNORED if `workflows` is provided.
+
+#### `workflows`
+
+Alias: w
+
+If you are using workflows in CircleCI, then this is for you! You need to tell `Sleet` which build(s) to look in, and where each output should be saved.
+The input is a hash, where the key is the build name and the value is the `output_file` for that build. Sleet supports saving the artifacts to multiple builds, meaning it can support a mono-repo setup.
+
+Build-Test-Deploy Demo:
+
+For this example you have three jobs in your CircleCI Workflow, `build`, `test` and `deploy`, but only 1 (the `test` build) generate an Rspec persistance file
+
+This command will pick the `test` build and save it's artificats to the `.rspec_example_statuses` file
+
+```
+sleet fetch --workflows test:.rspec_example_statuses
+```
+
+MonoRepo Demo:
+
+If you have a mono-repo that contains 3 sub-dirs. `foo`, `bar` and `baz`. And each one has an accompanying build. We can process all these sub-dirs at once with the following workflow command.
+
+```
+sleet fetch --workflows foo-test:foo/.rpsec_example_statuses bar-test:bar/.rspec_example_statuses baz-specs:baz/spec/examples.txt
+```

data/docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-slate

data/lib/sleet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sleet
-  VERSION = '0.4.1'
+  VERSION = '0.4.2'
 end

data/sleet.gemspec

@@ -28,15 +28,14 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'colorize', '~> 0.8.1'
   spec.add_dependency 'faraday', '>= 0.13.1', '< 0.16.0'
   spec.add_dependency 'rspec', '~> 3.0'
-  spec.add_dependency 'rugged', '>= 0.26', '< 0.28'
+  spec.add_dependency 'rugged', '>= 0.26', '< 0.29'
   spec.add_dependency 'terminal-table', '~> 1.8'
   spec.add_dependency 'thor', '~> 0.20.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'gem-release', '= 2.0.1'
   spec.add_development_dependency 'github_changelog_generator', '~> 1.14'
   spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'rubocop-coreyja', '0.3.0'
-  spec.add_development_dependency 'webmock', '~> 3.4.0'
+  spec.add_development_dependency 'rubocop-coreyja', '0.4.0'
+  spec.add_development_dependency 'webmock', '~> 3.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sleet
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Corey Alexander
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-24 00:00:00.000000000 Z
+date: 2019-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -67,7 +67,7 @@ dependencies:
         version: '0.26'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '0.29'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -77,7 +77,7 @@ dependencies:
         version: '0.26'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '0.29'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -106,20 +106,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.20.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
@@ -182,28 +168,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.1
 description: |
   Sleet provides an easy way to grab the most recent Rspec persistance files from CircleCI.
   It also aggregates the artificats from CircleCI, since you will have 1 per build container.
@@ -230,6 +216,9 @@ files:
 - bin/console
 - bin/release
 - bin/setup
+- docs/CNAME
+- docs/README.md
+- docs/_config.yml
 - exe/sleet
 - lib/sleet.rb
 - lib/sleet/artifact_downloader.rb
@@ -265,8 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: CircleCI RSpec Status Persistance File Aggregator

data/README.md

@@ -1,142 +0,0 @@
-# Sleet ☁️ ❄️
-
-[![Gem Version](https://badge.fury.io/rb/sleet.svg)](https://badge.fury.io/rb/sleet)
-[![Maintainability](https://api.codeclimate.com/v1/badges/7f346b368d72b53ef630/maintainability)](https://codeclimate.com/github/coreyja/sleet/maintainability)
-[![CircleCI](https://circleci.com/gh/coreyja/sleet.svg?style=svg)](https://circleci.com/gh/coreyja/sleet)
-
-## Background and Problem
-
-RSpec has a [feature](https://relishapp.com/rspec/rspec-core/v/3-7/docs/command-line/only-failures) that I find very useful which is the `--only-failures` option. This will re-run only that examples that failed the previous run.
-
-CircleCI has support for [uploading artifcats](https://circleci.com/docs/2.0/artifacts/) with your builds, which allows us to store the persistance file that powers the RSpec only failures option.
-However! CircleCI also supports and encourages parallelizing your build, which means even if you upload your rspec persistance file, you actually have a number of them each containing a subset of your test suite.
-This is where `Sleet` comes in!
-
-## Purpose
-
-This tool does two things:
-1. It downloads all of the `.rspec_failed_examples` files that were uploaded to CircleCI for the most recent build of the current branch
-2. It combines the multiple files into a single sorted `.rspec_failed_examples` file, and moves it to the [current directory](https://github.com/coreyja/CRSPFA/issues/1)
-
-## Getting Started
-
-### 1. Configure RSpec to Create and Use an example persistance file
-
-We need to set the `example_status_persistence_file_path` config in RSpec. Here are the relevant [RSpec docs](https://relishapp.com/rspec/rspec-core/v/3-7/docs/command-line/only-failures#background).
-
-The first step is to create(/or add to) your `spec/spec_helper.rb` file. We want to include the following configuration, which tells RSpec where to store the status persistance file. The actual location and file name are up to you, this is just an example. (Though using this name will require less configuration later.)
-
-```
-RSpec.configure do |c|
-  c.example_status_persistence_file_path = ".rspec_example_statuses"
-end
-```
-
-if you just created the `spec_helper.rb` file then you will need to create a `.rspec` file containing the following to load your new helper file.
-
-```
---require spec_helper
-```
-
-Again there are other ways to load your `spec_helper.rb` file, including requiring it from each spec. Pick one that works for you.
-
-### 2. Collect the example persistance files in CircleCI
-
-To do this we need to create a step which [saves](https://circleci.com/docs/2.0/artifacts/) the `.rspec_example_statuses` as artifacts of the build. The following is an example of such a step in CircleCI. This must happen after rspec has run or else the persistance file will not exist.
-
-```
-- store_artifacts:
-    path: .rspec_example_statuses
-
-```
-
-### 3. Save a CircleCI Token locally (to access private builds)
-
-In order to see private builds/repos in CircleCI you will need to get a CircleCI token and save it locally to a Sleet Configuration file.
-The recommended approach is to create a yml file in your home directory which contains your the key `circle_ci_token`
-
-```
-circle_ci_token: PLACE_TOKEN_HERE
-```
-
-An API token can be generated here: [https://circleci.com/account/api](https://circleci.com/account/api)
-
-### 4. Run this tool from your project
-
-```
-sleet
-```
-
-This will look up the latest completed build in CircleCI for this branch, and download all the relevant `.rspec_example_statuses` files. It then combines and sorts them and saves the result to the `.rspec_example_statuses` file locally.
-
-### 5. Run RSpec with `--only-failures`
-
-```
-bundle exec rspec --only-failures
-```
-
-This will run only the examples that failed in CircleCI!
-
-## Configuration
-
-If you are using Worklfows in your CircleCI builds, or you are working with a different persistance file name, you may need to configure Sleet beyond the defaults.
-
-Sleet currently supports two ways to input configurations:
-
-1. Through YML files
-    - `Sleet` will search 'up' from where the command was run and look for `.sleet.yml` files. It will combine all the files it finds, such that 'deeper' files take presedence. This allows you to have a user-level config at `~/.sleet.yml` and have project specific files which take presendence over the user level config (ex: `~/Projects/foo/.sleet.yml`)
-2. Through the CLI
-    - These always take presendece the options provided in the YML files
-
-To view your current configuration use the `sleet config` command which will give you a table of the current configuration. You can also use the `--print-config` flag with the `fetch` command to print out the config, including any other CLI options. This can be useful for bebugging as the output also tells you where each option came from.
-
-### Options
-
-These are the options that are currently supported
-
-#### `source_dir`
-
-Alias: s
-
-This is the directory of the source git repo. If a `source_dir` is NOT given we look up from the current directory for the nearest git repo.
-
-#### `input_file`
-
-Alias: i
-
-This is the name of the Rspec Circle Persistance File in CircleCI. The default is `.rspec_example_statuses`
-
-This will match if the full path on CircleCI ends in the given name.
-
-#### `output_file`
-
-Alias: o
-
-This is the name for the output file, on your local system. It is relative to the `source_dir`.
-
-Will be IGNORED if `workflows` is provided.
-
-#### `workflows`
-
-Alias: w
-
-If you are using workflows in CircleCI, then this is for you! You need to tell `Sleet` which build(s) to look in, and where each output should be saved.
-The input is a hash, where the key is the build name and the value is the `output_file` for that build. Sleet supports saving the artifacts to multiple builds, meaning it can support a mono-repo setup.
-
-Build-Test-Deploy Demo:
-
-For this example you have three jobs in your CircleCI Workflow, `build`, `test` and `deploy`, but only 1 (the `test` build) generate an Rspec persistance file
-
-This command will pick the `test` build and save it's artificats to the `.rspec_example_statuses` file
-
-```
-sleet fetch --workflows test:.rspec_example_statuses
-```
-
-MonoRepo Demo:
-
-If you have a mono-repo that contains 3 sub-dirs. `foo`, `bar` and `baz`. And each one has an accompanying build. We can process all these sub-dirs at once with the following workflow command.
-
-```
-sleet fetch --workflows foo-test:foo/.rpsec_example_statuses bar-test:bar/.rspec_example_statuses baz-specs:baz/spec/examples.txt
-```