diff --git a/Gemfile b/Gemfile index 436e4d2..0b53f59 100644 --- a/Gemfile +++ b/Gemfile @@ -2,6 +2,3 @@ source 'https://rubygems.org' # Specify your gem's dependencies in sidekiq-failures.gemspec gemspec - -# FIXME remove once tabs support is released -gem "sidekiq", github: "mperham/sidekiq" diff --git a/README.md b/README.md index 43fd703..07057d4 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,36 @@ # Sidekiq::Failures Keeps track of Sidekiq failed jobs and adds a tab to the Web UI to let you browse -them. Makes use of Sidekiq's custom tabs and middlewares. +them. Makes use of Sidekiq's custom tabs and middleware chain. + +It mimics the way Resque keeps track of failures. Note that each failed retry will create a new failed job. This might result in a -prety big failures list. Think twice before using this project. In most cases -automatic retries allied with exception notifications will be enough. +pretty big failures list. Think twice before using this project. In most cases +automatic retries allied to exception notifications will be enough. + +## Important Note! + +This is an ongoing, alpha level project. Be prepared that the API might change and bugs might occur. ## Installation Add this line to your application's Gemfile: - gem 'sidekiq-failures' +```ruby +gem 'sidekiq-failures' +``` -And then execute: +## Dependencies - $ bundle +Depends on Sidekiq >= 2.2.1 ## Usage Simply having the gem in your Gemfile should be enough. +Your failed jobs will be visible via a Failures tab in the Web UI. + ## Contributing 1. Fork it @@ -28,3 +38,9 @@ Simply having the gem in your Gemfile should be enough. 3. Commit your changes (`git commit -am 'Added some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create new Pull Request + +## License + +Released under the MIT License. See the [LICENSE][license] file for further details. + +[license]: https://github.com/mhfs/sidekiq-failures/blob/master/LICENSE diff --git a/sidekiq-failures.gemspec b/sidekiq-failures.gemspec index b744f4d..c71c35d 100644 --- a/sidekiq-failures.gemspec +++ b/sidekiq-failures.gemspec @@ -4,8 +4,8 @@ require File.expand_path('../lib/sidekiq/failures/version', __FILE__) Gem::Specification.new do |gem| gem.authors = ["Marcelo Silveira"] gem.email = ["marcelo@mhfs.com.br"] - gem.description = %q{Keep track of Sidekiq failed jobs and add a tab to the Web UI to let you browse and manually retry them} - gem.summary = %q{Keep track of Sidekiq failed jobs and add a tab to the Web UI to let you browse and manually retry them} + gem.description = %q{Keep track of Sidekiq failed jobs} + gem.summary = %q{Keeps track of Sidekiq failed jobs and adds a tab to the Web UI to let you browse them. Makes use of Sidekiq's custom tabs and middleware chain.} gem.homepage = "https://github.com/mhfs/sidekiq-failures/" gem.files = `git ls-files`.split($\) @@ -15,8 +15,7 @@ Gem::Specification.new do |gem| gem.require_paths = ["lib"] gem.version = Sidekiq::Failures::VERSION - # FIXME uncomment once tab support is released - # gem.add_dependency "sidekiq" + gem.add_dependency "sidekiq", ">= 2.2.1" gem.add_dependency "slim" gem.add_dependency "sinatra" gem.add_dependency "sprockets"