README.md in worker-glass-0.2.4 vs README.md in worker-glass-0.2.5
- old
+ new
@@ -1,9 +1,10 @@
-# Worker Glass
+# Worker Glass [Unmaintained]
-[](https://travis-ci.org/karafka/worker-glass) [](https://codeclimate.com/github/karafka/worker-glass)
-[](http://badge.fury.io/rb/worker-glass)
+**Note**: This library is no longer in use in the Karafka ecosystem. It was developed for Karafka versions prior to `1.0`. If you're using this library and want to take it over, please ping us.
+
+[](https://github.com/karafka/worker-glass/actions?query=workflow%3Aci)
[](https://gitter.im/karafka/karafka?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
WorkerGlass provides optional timeout and after failure (reentrancy) for background processing worker engines (like Sidekiq, Resque, etc).
## Reentrancy
@@ -48,11 +49,11 @@
Worker2.perform_async(example1, example2, example3)
```
### WorkerGlass::Reentrancy
-If you want to provide reentrancy for your workers, just prepend WorkerGlass::Reentrancy to your worker and define **after_failure** method that will be executed uppon failure:
+If you want to provide reentrancy for your workers, just prepend WorkerGlass::Reentrancy to your worker and define **after_failure** method that will be executed upon failure:
```ruby
class Worker3
prepend WorkerGlass::Reentrancy
@@ -68,33 +69,20 @@
Worker3.perform_async(example1, example2, example3)
```
## References
-* [Sidekiq](http://sidekiq.org/)
* [Karafka framework](https://github.com/karafka/karafka)
-* [Capistrano Karafka](https://github.com/karafka/capistrano-karafka)
-* [Waterdrop](https://github.com/karafka/waterdrop)
-* [Worker Glass](https://github.com/karafka/worker-glass)
-* [Envlogic](https://github.com/karafka/envlogic)
-* [Null Logger](https://github.com/karafka/null-logger)
-* [Worker Glass Travis CI](https://travis-ci.org/karafka/worker-glass)
-* [Worker Glass Code Climate](https://codeclimate.com/github/karafka/worker-glass)
+* [Worker Glass Actions CI](https://github.com/karafka/worker-glass/actions?query=workflow%3Aci)
+* [Worker Glass Coditsu](https://app.coditsu.io/karafka/repositories/worker-glass)
-## Note on Patches/Pull Requests
+## Note on contributions
-Fork the project.
-Make your feature addition or bug fix.
-Add tests for it. This is important so I don't break it in a future version unintentionally.
-Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull). Send me a pull request. Bonus points for topic branches.
+First, thank you for considering contributing to Worker Glass! It's people like you that make the open source community such a great community!
-[](https://coditsu.io)
+Each pull request must pass all the RSpec specs and meet our quality requirements.
-Each pull request must pass our quality requirements. To check if everything is as it should be, we use [Coditsu](https://coditsu.io) that combinse multiple linters and code analyzers. Unfortunately, for now it is invite-only based, so just ping us and we will give you access to the quality results.
+To check if everything is as it should be, we use [Coditsu](https://coditsu.io) that combines multiple linters and code analyzers for both code and documentation. Once you're done with your changes, submit a pull request.
-Please run:
+Coditsu will automatically check your work against our quality standards. You can find your commit check results on the [builds page](https://app.coditsu.io/karafka/repositories/worker-glass/builds/commit_builds) of Worker Glass repository.
-```bash
-bundle exec rake
-```
-
-to check if everything is in order. After that you can submit a pull request.
+[](https://app.coditsu.io/karafka/repositories/worker-glass/builds/commit_builds)