/spec_snitch

Turn your pending specs into GitHub issues

Primary LanguageRubyMIT LicenseMIT

Snitch

Snitch creates a GitHub issue for each pending spec in your suite, making it harder for you to ignore those features you've been putting off. Using only a GitHub API access token and the name of your repo, Snitch will create GitHub issues using the full descriptions of your pending specs.

Installation

Add this line to your application's Gemfile:

gem 'snitch', github: 'freddyrangel/snitch'

And then execute:

$ bundle

Usage

To get started, you'll only need two things:

  1. A valid repo name (i.e. "freddyrangel/snitch")
  2. A GitHub API access token for an account authorized to contribute to that repo.

To get your access token, go to your GitHub Settings > Applications, and under your "Personal Access Tokens" panel, click on "Generate new token". The default settings will work fine, but at the very least you'll need to have the "repo" scope enabled.

Once you've done all that, simply add the following to your RSpec configuration:

RSpec.configure do |config|
  config.after(:suite) do
    Snitch.snitch_to config, repository: [your repo name here],
      access_token: [your access_token], ask: false
  end

  # other stuff...
end

Setting ask: true will cause Snitch to ask you after each run of your test suite if you'd like to snitch. This could be annoying, so we've defaulted to false.

Pro-tip: Use with your Continuous Integration server

If you find Snitch is slowing down your test flow too much, or you'd rather not report on every run, or worse, you'd rather not be asked after every run, you can safely leave your SNITCH_TOKEN unset, and it will simply alert you with a message in your suite's output.

But if you set the environment variable (SNITCH_TOKEN) in your CI server's config, you can have Snitch only do its thing when a commit is pushed to GitHub (thus triggering a build on your CI server). This helps reduce snitching to times when you've come to a reasonable break in your work.

Contributing

  1. Fork it ( http://github.com//snitch/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 new Pull Request