sleet 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c74ecb0b18d854d65663b9afc1ee7c9d9c1778596a37ad4759830f287f871166
-  data.tar.gz: 686ca59258b5308b7ca0442f602d73ca5cec4d2d21020a0e0bc59bd69f481e84
+  metadata.gz: e75141d27425d21f50ad88c1d003b95be8c764ddcd9fe0ae7f8338f6974b49b9
+  data.tar.gz: 1ad638ca66c29aa410fd93ff536fa4e1c0c0675c1ca9d37b813359a78a5f73d6
 SHA512:
-  metadata.gz: c9f09ed96fbc87f8c9c4c95c30cfdb81abdef368d366e35c9abdbdc20d2ea6c65f7721c49a0bf987099b888c824c9c62f132c547a494cec97bcf93c1d755dd6a
-  data.tar.gz: 5c36a2ccfae4b51f94506657371c527248a9983623506c83171054c7604f21cf76b67657207d83b5b8dab80a7750555178cd73c136de23d63a4fa91dab17393c
+  metadata.gz: 5ad5af55d1a6d79ca76b4179eb0322dedca20ddc4228f86cafa70d8768f8a2e29add248590a450a6ef100973f28afcbc09c854dc930c319dee7708b63c2a3f65
+  data.tar.gz: 06244c1173c20720f0cfd7bfce45b7c5f9749e5ed76ea83214b1aa575cac33b22b9c06a22bfdb8fea4831e1c676aebfba17571d59c574845f3f3aa9e0c9d3e2a

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## [v0.3.2](https://github.com/coreyja/sleet/tree/v0.3.2) (2018-01-15)
+[Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.1...v0.3.2)
+
+**Merged pull requests:**
+
+- Update Readme and Add Descriptions to Help Menus [\#8](https://github.com/coreyja/sleet/pull/8) ([coreyja](https://github.com/coreyja))
+
 ## [v0.3.1](https://github.com/coreyja/sleet/tree/v0.3.1) (2018-01-15)
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.0...v0.3.1)
 

data/README.md

@@ -1,4 +1,4 @@
-# CircleCI RSpec Status Persistance File Aggregator
+# Sleet
 
 ## Background and Problem
 
@@ -6,7 +6,7 @@ RSpec has a [feature](https://relishapp.com/rspec/rspec-core/v/3-7/docs/command-
 
 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 this tool comes in!
+This is where `Sleet` comes in!
 
 ## Purpose
 
@@ -18,11 +18,9 @@ This tool does two things:
 
 ### 1. Configure RSpec to Create and Use an example persistance file
 
-A current limitation is that the RSpec Persistance file must be named `.rspec_example_statuses`.
-
 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 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|
@@ -30,23 +28,31 @@ RSpec.configure do |c|
 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
+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: ~/PROJECT_NAME/.rspec_example_statuses
+    path: .rspec_example_statuses
 
 ```
 
-### 3. Run this tool in the root of your project
+### 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 to the `~/.circleci.token` file.
+
+An API token can be generated here: [https://circleci.com/account/api](https://circleci.com/account/api)
+
+### 4. Run this tool in the root of your project
 
 ```
 sleet
@@ -54,10 +60,72 @@ 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.
 
-### 4. Run RSpec with `--only-failures`
+### 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
+
+### 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 saw 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/lib/sleet/cli.rb

@@ -4,11 +4,25 @@ module Sleet
   class Cli < Thor
     default_task :fetch
 
-    desc 'Fetch Rspec Status File from CircleCI', 'fetch'
-    option :source_dir, type: :string, aliases: [:s]
-    option :input_file, type: :string, aliases: [:i]
-    option :output_file, type: :string, aliases: [:o]
-    option :workflows, type: :hash, aliases: [:w]
+    desc 'fetch', 'Fetch and Aggregate RSpec Persistance Files from CircleCI'
+    long_desc <<~LONGDESC
+      `sleet fetch` will find build(s) in CircleCI for the current branch, and
+      download the chosen Rspec Persistance Files. Since there will be 1 per container,
+      and builds may have more than 1 container `sleet` will combine all the indivudual
+      persistance files.
+    LONGDESC
+    option :source_dir, type: :string, aliases: [:s], desc: <<~DESC
+      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.
+    DESC
+    option :input_file, type: :string, aliases: [:i], desc: <<~DESC
+      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.
+    DESC
+    option :output_file, type: :string, aliases: [:o], desc: <<~DESC
+      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.
+    DESC
+    option :workflows, type: :hash, aliases: [:w], desc: <<~DESC
+      To use Sleet with CircleCI Workflows 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.
+    DESC
     def fetch
       if options[:workflows]
         workflow_fetch

data/lib/sleet/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sleet
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Corey Alexander
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-15 00:00:00.000000000 Z
+date: 2018-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize